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