java.util

Class AbstractMap.SimpleEntry<K,V>

java.lang.Object

java.util.AbstractMap.SimpleEntry<K,V>

All Implemented Interfaces:

Serializable, Map.Entry<K,V>

Enclosing class:

AbstractMap<K,V>

public static class AbstractMap.SimpleEntry<K,V>
extends Object
implements Map.Entry<K,V>, Serializable

A key-value mapping with mutable values.

Since:

1.6

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleEntry(K theKey, V theValue)
SimpleEntry(Map.Entry<? extends K,? extends V> copyFrom) Constructs an instance with the key and value of copyFrom.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Compares this instance with the specified object and indicates if they are equal.
K	getKey() Returns the key corresponding to this entry.
V	getValue() Returns the value corresponding to this entry.
int	hashCode() Returns an integer hash code for this object.
V	setValue(V object) Replaces the value corresponding to this entry with the specified value (optional operation).
String	toString() Returns a string containing a concise, human-readable description of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

SimpleEntry

public SimpleEntry(K theKey,
                   V theValue)

SimpleEntry

public SimpleEntry(Map.Entry<? extends K,? extends V> copyFrom)

Constructs an instance with the key and value of copyFrom.

Method Detail

getKey

public K getKey()

Description copied from interface: Map.Entry

Returns the key corresponding to this entry.

Specified by:

getKey in interface Map.Entry<K,V>

Returns:

the key corresponding to this entry

getValue

public V getValue()

Description copied from interface: Map.Entry

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.

Specified by:

getValue in interface Map.Entry<K,V>

Returns:

the value corresponding to this entry

setValue

public V setValue(V object)

Description copied from interface: Map.Entry

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).

Specified by:

setValue in interface Map.Entry<K,V>

Parameters:

object - new value to be stored in this entry

Returns:

old value corresponding to the entry

equals

public boolean equals(Object object)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Specified by:

equals in interface Map.Entry<K,V>

Overrides:

equals in class Object

Parameters:

object - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Specified by:

hashCode in interface Map.Entry<K,V>

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.