Class DefaultKeyValue<K,V>
java.lang.Object
org.apache.commons.collections4.keyvalue.AbstractKeyValue<K,V>
org.apache.commons.collections4.keyvalue.DefaultKeyValue<K,V>
- Type Parameters:
K
- the type of keysV
- the type of values
- All Implemented Interfaces:
KeyValue<K,
V>
A mutable
KeyValue
pair that does not implement
Map.Entry
.
Note that a DefaultKeyValue
instance may not contain
itself as a key or value.
- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionConstructs a new pair with a null key and null value.DefaultKeyValue
(Map.Entry<? extends K, ? extends V> entry) Constructs a new pair from the specifiedMap.Entry
.DefaultKeyValue
(K key, V value) Constructs a new pair with the specified key and given value.DefaultKeyValue
(KeyValue<? extends K, ? extends V> pair) Constructs a new pair from the specifiedKeyValue
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares thisMap.Entry
with anotherMap.Entry
.int
hashCode()
Gets a hashCode compatible with the equals method.Sets the key.Sets the value.Returns a newMap.Entry
object with key and value from this pair.Methods inherited from class org.apache.commons.collections4.keyvalue.AbstractKeyValue
getKey, getValue, toString
-
Constructor Details
-
DefaultKeyValue
public DefaultKeyValue()Constructs a new pair with a null key and null value. -
DefaultKeyValue
Constructs a new pair with the specified key and given value.- Parameters:
key
- the key for the entry, may be nullvalue
- the value for the entry, may be null
-
DefaultKeyValue
Constructs a new pair from the specifiedKeyValue
.- Parameters:
pair
- the pair to copy, must not be null- Throws:
NullPointerException
- if the entry is null
-
DefaultKeyValue
Constructs a new pair from the specifiedMap.Entry
.- Parameters:
entry
- the entry to copy, must not be null- Throws:
NullPointerException
- if the entry is null
-
-
Method Details
-
equals
Compares thisMap.Entry
with anotherMap.Entry
.Returns true if the compared object is also a
DefaultKeyValue
, and its key and value are equal to this object's key and value. -
hashCode
Gets a hashCode compatible with the equals method.Implemented per API documentation of
Map.Entry.hashCode()
, however subclasses may override this. -
setKey
Sets the key.- Overrides:
setKey
in classAbstractKeyValue<K,
V> - Parameters:
key
- the new key- Returns:
- the old key
- Throws:
IllegalArgumentException
- if key is this object
-
setValue
Sets the value.- Overrides:
setValue
in classAbstractKeyValue<K,
V> - Parameters:
value
- the new value- Returns:
- the old value of the value
- Throws:
IllegalArgumentException
- if value is this object
-
toMapEntry
Returns a newMap.Entry
object with key and value from this pair.- Returns:
- a MapEntry instance
-