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  /***
23   * This is a node in the double linked list. It is stored as the value in the
24   * underlying map used by the LRUMap class.
25   * <p>
26   * @author aaronsm
27   */
28  public class LRUElementDescriptor
29      extends DoubleLinkedListNode
30  {
31      private static final long serialVersionUID = 8249555756363020156L;
32  
33      /***
34       * <code>key</code>
35       */
36      private Object key;
37  
38      /***
39       * @param key
40       * @param payloadP
41       */
42      public LRUElementDescriptor( Object key, Object payloadP )
43      {
44          super( payloadP );
45          this.setKey( key );
46      }
47  
48      /***
49       * @param key
50       *            The key to set.
51       */
52      public void setKey( Object key )
53      {
54          this.key = key;
55      }
56  
57      /***
58       * @return Returns the key.
59       */
60      public Object getKey()
61      {
62          return key;
63      }
64  
65  }