org.apache.commons.collections4.keyvalue

Class TiedMapEntry<K,V>

java.lang.Object

org.apache.commons.collections4.keyvalue.TiedMapEntry<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map.Entry<K,V>, KeyValue<K,V>

public class TiedMapEntry<K,V>
extends java.lang.Object
implements java.util.Map.Entry<K,V>, KeyValue<K,V>, java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TiedMapEntry(java.util.Map<K,V> map, K key) Constructs a new entry with the given Map and key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares this Map.Entry with another Map.Entry.
K	getKey() Gets the key of this entry
V	getValue() Gets the value of this entry direct from the map.
int	hashCode() Gets a hashCode compatible with the equals method.
V	setValue(V value) Sets the value associated with the key direct onto the map.
java.lang.String	toString() Gets a string version of the entry.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

TiedMapEntry

public TiedMapEntry(java.util.Map<K,V> map,
                    K key)

Constructs a new entry with the given Map and key.

Parameters:

map - the map

key - the key

Method Detail

getKey

public K getKey()

Gets the key of this entry

Specified by:

getKey in interface java.util.Map.Entry<K,V>

Specified by:

getKey in interface KeyValue<K,V>

Returns:

the key

getValue

public V getValue()

Gets the value of this entry direct from the map.

Specified by:

getValue in interface java.util.Map.Entry<K,V>

Specified by:

getValue in interface KeyValue<K,V>

Returns:

the value

setValue

public V setValue(V value)

Sets the value associated with the key direct onto the map.

Specified by:

setValue in interface java.util.Map.Entry<K,V>

Parameters:

value - the new value

Returns:

the old value

Throws:

java.lang.IllegalArgumentException - if the value is set to this map entry

equals

public boolean equals(java.lang.Object obj)

Compares this Map.Entry with another Map.Entry.

Implemented per API documentation of Map.Entry.equals(Object)

Specified by:

equals in interface java.util.Map.Entry<K,V>

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to

Returns:

true if equal key and value

hashCode

public int hashCode()

Gets a hashCode compatible with the equals method.

Implemented per API documentation of Map.Entry.hashCode()

Specified by:

hashCode in interface java.util.Map.Entry<K,V>

Overrides:

hashCode in class java.lang.Object

Returns:

a suitable hash code

toString

public java.lang.String toString()

Gets a string version of the entry.

Overrides:

toString in class java.lang.Object

Returns:

entry as a string