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.collections4.keyvalue;
18
19 import java.util.Map;
20
21 import org.apache.commons.collections4.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 * @param <K> the type of keys
28 * @param <V> the type of mapped values
29 * @since 3.0
30 */
31 public final class DefaultMapEntry<K, V> extends AbstractMapEntry<K, V> {
32
33 /**
34 * Constructs a new entry with the specified key and given value.
35 *
36 * @param key the key for the entry, may be null
37 * @param value the value for the entry, may be null
38 */
39 public DefaultMapEntry(final K key, final V value) {
40 super(key, value);
41 }
42
43 /**
44 * Constructs a new entry from the specified {@code KeyValue}.
45 *
46 * @param pair the pair to copy, must not be null
47 * @throws NullPointerException if the entry is null
48 */
49 public DefaultMapEntry(final KeyValue<? extends K, ? extends V> pair) {
50 super(pair.getKey(), pair.getValue());
51 }
52
53 /**
54 * Constructs a new entry from the specified {@code Map.Entry}.
55 *
56 * @param entry the entry to copy, must not be null
57 * @throws NullPointerException if the entry is null
58 */
59 public DefaultMapEntry(final Map.Entry<? extends K, ? extends V> entry) {
60 super(entry.getKey(), entry.getValue());
61 }
62
63 }