View Javadoc

1   package org.apache.jcs.utils.struct;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.Serializable;
23  
24  /***
25   * This serves as a placeholder in a double linked list. You can extend this to
26   * add functionality. This allows you to remove in constant time from a linked
27   * list.
28   * <p>
29   * It simply holds the payload and a reference to the items before and after it
30   * in the list.
31   */
32  public class DoubleLinkedListNode
33      implements Serializable
34  {
35      private static final long serialVersionUID = -1114934407695836097L;
36  
37      private Object payload;
38  
39      /*** Double Linked list references */
40      public DoubleLinkedListNode prev;
41  
42      /*** Double Linked list references */
43      public DoubleLinkedListNode next;
44  
45      /***
46       * @param payloadP
47       */
48      public DoubleLinkedListNode( Object payloadP )
49      {
50          payload = payloadP;
51      }
52  
53      /***
54       * @return Object
55       */
56      public Object getPayload()
57      {
58          return payload;
59      }
60  }