Apache Commons Collections 4.4 · org.apache.commons.collections4.keyvalue.AbstractMapEntryDecorator

Modifier and Type	Field and Description
private final Map.Entry<K, V>	entry The `Map.Entry` to decorate

Access	Constructor and Description
public	AbstractMapEntryDecorator(final Map.Entry<K, V> the `Map.Entry` to decorate, must not be null entry) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object object to be compared for equality with this map entry object) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Compares the specified object with this entry for equality.
public K	getKey() Implements java.util.Map.Entry.getKey, org.apache.commons.collections4.KeyValue.getKey. Returns the key corresponding to this entry.
protected Map.Entry<K, V>	Returns: the decorated map getMapEntry() Gets the map being decorated.
public V	getValue() Implements java.util.Map.Entry.getValue, org.apache.commons.collections4.KeyValue.getValue. Returns the value corresponding to this entry.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Returns the hash code value for this map entry.
public V	setValue(final V new value to be stored in this entry object) Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

entry	back to summary
private final Map.Entry<K, V> entry The `Map.Entry` to decorate

AbstractMapEntryDecorator	back to summary
public AbstractMapEntryDecorator(final Map.Entry<K, V> entry) Constructor that wraps (not copies). Parameters entry:Map.Entry<K, V> the `Map.Entry` to decorate, must not be null Exceptions NullPointerException: if the collection is null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object object) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Doc from java.util.Map.Entry.equals. Compares the specified object with this entry for equality. Returns `true` if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries `e1` and `e2` represent the same mapping if (e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) && (e1.getValue()==null ? e2.getValue()==null : e1.getValue().equals(e2.getValue())) This ensures that the `equals` method works properly across different implementations of the `Map.Entry` interface. Parameters object:Object object to be compared for equality with this map entry Returns:boolean `true` if the specified object is equal to this map entry Annotations @Override

public boolean equals(final Object object)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Doc from java.util.Map.Entry.equals.

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries e1 and e2 represent the same mapping if

    (e1.getKey()==null ?
     e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
    (e1.getValue()==null ?
     e2.getValue()==null : e1.getValue().equals(e2.getValue()))

This ensures that the equals method works properly across different implementations of the Map.Entry interface.

Parameters

object:Object: object to be compared for equality with this map entry

Returns:boolean

true if the specified object is equal to this map entry

Annotations

@Override

getKey	back to summary
public K getKey() Implements java.util.Map.Entry.getKey, org.apache.commons.collections4.KeyValue.getKey. Doc from java.util.Map.Entry.getKey. Returns the key corresponding to this entry. Returns:K the key corresponding to this entry Annotations @Override

getKey

back to summary

public K getKey()

Implements java.util.Map.Entry.getKey, org.apache.commons.collections4.KeyValue.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:K

the key corresponding to this entry

Annotations

@Override

getMapEntry	back to summary
protected Map.Entry<K, V> getMapEntry() Gets the map being decorated. Returns:Map.Entry<K, V> the decorated map

getMapEntry

back to summary

protected Map.Entry<K, V> getMapEntry()

Gets the map being decorated.

Returns:Map.Entry<K, V>: the decorated map

getValue back to summary

getValue	back to summary
public V getValue() Implements java.util.Map.Entry.getValue, org.apache.commons.collections4.KeyValue.getValue. Doc from java.util.Map.Entry.getValue. Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's `remove` operation), the results of this call are undefined. Returns:V the value corresponding to this entry Annotations @Override

public V getValue()

Implements java.util.Map.Entry.getValue, org.apache.commons.collections4.KeyValue.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:V

the value corresponding to this entry

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Doc from java.util.Map.Entry.hashCode. Returns the hash code value for this map entry. The hash code of a map entry `e` is defined to be: (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ (e.getValue()==null ? 0 : e.getValue().hashCode()) This ensures that `e1.equals(e2)` implies that `e1.hashCode()==e2.hashCode()` for any two Entries `e1` and `e2`, as required by the general contract of `Object.hashCode`. Returns:int the hash code value for this map entry Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Doc from java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry. The hash code of a map entry e is defined to be:

    (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
    (e.getValue()==null ? 0 : e.getValue().hashCode())

This ensures that e1.equals(e2) implies that e1.hashCode()==e2.hashCode() for any two Entries e1 and e2, as required by the general contract of Object.hashCode.

Returns:int

the hash code value for this map entry

Annotations

@Override

setValue back to summary

setValue	back to summary
public V setValue(final V object) Implements java.util.Map.Entry.setValue. Doc from java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's `remove` operation). Parameters object:V new value to be stored in this entry Returns:V old value corresponding to the entry Annotations @Override

public V setValue(final V object)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters

object:V: new value to be stored in this entry

Returns:V

old value corresponding to the entry

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class AbstractMapEntryDecorator<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail