View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.mavibot.btree;
21  
22  
23  /**
24   * The data structure holding a key and the way to access it
25   * 
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   * 
28   * <K> The key type
29   */
30  /* No qualifier*/class KeyHolder<K>
31  {
32      /** The deserialized key */
33      protected K key;
34  
35  
36      /**
37       * Create a new KeyHolder instance
38       * 
39       * @param key The key to store
40       */
41      /* no qualifier */KeyHolder( K key )
42      {
43          this.key = key;
44      }
45  
46  
47      /**
48       * {@inheritDoc}
49       */
50      /* no qualifier */void setKey( K key )
51      {
52          this.key = key;
53      }
54  
55  
56      /**
57       * {@inheritDoc}
58       */
59      /* no qualifier */K getKey()
60      {
61          return key;
62      }
63  
64  
65      /**
66       * @see Object#toString()
67       */
68      public String toString()
69      {
70          return key.toString();
71      }
72  }