Added in API level 9

AbstractMap.SimpleEntry

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

java.lang.Object
   ↳ java.util.AbstractMap.SimpleEntry<K, V>


An Entry maintaining a key and a value. The value may be changed using the setValue method. Instances of this class are not associated with any map nor with any map's entry-set view.

Summary

Public constructors

SimpleEntry(K key, V value)

Creates an entry representing a mapping from the specified key to the specified value.

SimpleEntry(Entry<? extends K, ? extends V> entry)

Creates an entry representing the same mapping as the specified entry.

Public methods

boolean equals(Object o)

Compares the specified object with this entry for equality.

K getKey()

Returns the key corresponding to this entry.

V getValue()

Returns the value corresponding to this entry.

int hashCode()

Returns the hash code value for this map entry.

V setValue(V value)

Replaces the value corresponding to this entry with the specified value.

String toString()

Returns a String representation of this map entry.

Inherited methods

Public constructors

SimpleEntry

Added in API level 9
public SimpleEntry (K key, 
                V value)

Creates an entry representing a mapping from the specified key to the specified value.

Parameters
key K: the key represented by this entry

value V: the value represented by this entry

SimpleEntry

Added in API level 9
public SimpleEntry (Entry<? extends K, ? extends V> entry)

Creates an entry representing the same mapping as the specified entry.

Parameters
entry Entry: the entry to copy

Public methods

equals

Added in API level 9
public boolean equals (Object o)

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
o Object: object to be compared for equality with this map entry

Returns
boolean true if the specified object is equal to this map entry

See also:

getKey

Added in API level 9
public K getKey ()

Returns the key corresponding to this entry.

Returns
K the key corresponding to this entry

getValue

Added in API level 9
public V getValue ()

Returns the value corresponding to this entry.

Returns
V the value corresponding to this entry

hashCode

Added in API level 9
public int 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

See also:

setValue

Added in API level 9
public V setValue (V value)

Replaces the value corresponding to this entry with the specified value.

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

Returns
V the old value corresponding to the entry

toString

Added in API level 9
public String toString ()

Returns a String representation of this map entry. This implementation returns the string representation of this entry's key followed by the equals character ("=") followed by the string representation of this entry's value.

Returns
String a String representation of this map entry