View Javadoc

1   /*
2    *  Copyright 2003-2004 The Apache Software Foundation
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.collections15;
17  
18  /***
19   * Defines a simple key value pair.
20   * <p/>
21   * A Map Entry has considerable additional semantics over and above a simple
22   * key-value pair. This interface defines the minimum key value, with just the
23   * two get methods.
24   *
25   * @author Stephen Colebourne
26   * @version $Revision: 1.2 $ $Date: 2004/10/17 01:02:42 $
27   * @since Commons Collections15 1.0
28   */
29  public interface KeyValue <K, V>
30  {
31  
32      /***
33       * Gets the key from the pair.
34       *
35       * @return the key
36       */
37      K getKey();
38  
39      /***
40       * Gets the value from the pair.
41       *
42       * @return the value
43       */
44      V getValue();
45  
46  }