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    *      http://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  package org.apache.commons.collections.keyvalue;
18  
19  import java.util.Map;
20  
21  import org.apache.commons.collections.KeyValue;
22  
23  /**
24   * A restricted implementation of {@link java.util.Map.Entry Map.Entry} that prevents
25   * the {@link java.util.Map.Entry Map.Entry} contract from being broken.
26   *
27   * @since 3.0
28   * @version $Id: DefaultMapEntry.java 1436026 2013-01-21 00:55:20Z sebb $
29   */
30  public final class DefaultMapEntry<K, V> extends AbstractMapEntry<K, V> {
31  
32      /**
33       * Constructs a new entry with the specified key and given value.
34       *
35       * @param key  the key for the entry, may be null
36       * @param value  the value for the entry, may be null
37       */
38      public DefaultMapEntry(final K key, final V value) {
39          super(key, value);
40      }
41  
42      /**
43       * Constructs a new entry from the specified <code>KeyValue</code>.
44       *
45       * @param pair  the pair to copy, must not be null
46       * @throws NullPointerException if the entry is null
47       */
48      public DefaultMapEntry(final KeyValue<K, V> pair) {
49          super(pair.getKey(), pair.getValue());
50      }
51  
52      /**
53       * Constructs a new entry from the specified <code>Map.Entry</code>.
54       *
55       * @param entry  the entry to copy, must not be null
56       * @throws NullPointerException if the entry is null
57       */
58      public DefaultMapEntry(final Map.Entry<K, V> entry) {
59          super(entry.getKey(), entry.getValue());
60      }
61  
62  }