Class TiedMapEntry<K,V>
java.lang.Object
org.apache.commons.collections4.keyvalue.TiedMapEntry<K,V>
- Type Parameters:
K
- the type of keysV
- the type of mapped values
- All Implemented Interfaces:
Serializable
,Map.Entry<K,
,V> KeyValue<K,
V>
public class TiedMapEntry<K,V>
extends Object
implements Map.Entry<K,V>, KeyValue<K,V>, Serializable
A
Map.Entry
tied to a map underneath.
This can be used to enable a map entry to make changes on the underlying map, however this will probably mess up any iterators.
- Since:
- 3.0
- See Also:
-
Constructor Summary
ConstructorDescriptionTiedMapEntry
(Map<K, V> map, K key) Constructs a new entry with the given Map and key. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares thisMap.Entry
with anotherMap.Entry
.getKey()
Gets the key of this entrygetValue()
Gets the value of this entry direct from the map.int
hashCode()
Gets a hashCode compatible with the equals method.Sets the value associated with the key direct onto the map.toString()
Gets a string version of the entry.
-
Constructor Details
-
TiedMapEntry
Constructs a new entry with the given Map and key.- Parameters:
map
- the mapkey
- the key
-
-
Method Details
-
equals
Compares thisMap.Entry
with anotherMap.Entry
.Implemented per API documentation of
Map.Entry.equals(Object)
-
getKey
Gets the key of this entry -
getValue
Gets the value of this entry direct from the map. -
hashCode
Gets a hashCode compatible with the equals method.Implemented per API documentation of
Map.Entry.hashCode()
-
setValue
Sets the value associated with the key direct onto the map.- Specified by:
setValue
in interfaceMap.Entry<K,
V> - Parameters:
value
- the new value- Returns:
- the old value
- Throws:
IllegalArgumentException
- if the value is set to this map entry
-
toString
Gets a string version of the entry.
-