AbstractMap.SimpleEntry (Java Platform SE 6) (original) (raw)

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

An Entry maintaining a key and a value. The value may be changed using the setValue method. This class facilitates the process of building custom map implementations. For example, it may be convenient to return arrays of SimpleEntry instances in methodMap.entrySet().toArray.

Since:

1.6

See Also:

Serialized Form

AbstractMap.SimpleEntry

public AbstractMap.SimpleEntry(K key, V value)

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

Parameters:

key - the key represented by this entry

value - the value represented by this entry

AbstractMap.SimpleEntry

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

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

Parameters:

entry - the entry to copy

getKey

public K getKey()

Returns the key corresponding to this entry.

Specified by:

[getKey](../../java/util/Map.Entry.html#getKey%28%29) in interface [Map.Entry](../../java/util/Map.Entry.html "interface in java.util")<[K](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry"),[V](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry")>

Returns:

the key corresponding to this entry

getValue

public V getValue()

Returns the value corresponding to this entry.

Specified by:

[getValue](../../java/util/Map.Entry.html#getValue%28%29) in interface [Map.Entry](../../java/util/Map.Entry.html "interface in java.util")<[K](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry"),[V](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry")>

Returns:

the value corresponding to this entry

setValue

public V setValue(V value)

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

Specified by:

[setValue](../../java/util/Map.Entry.html#setValue%28V%29) in interface [Map.Entry](../../java/util/Map.Entry.html "interface in java.util")<[K](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry"),[V](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry")>

Parameters:

value - new value to be stored in this entry

Returns:

the old value corresponding to the entry

equals

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.

Specified by:

[equals](../../java/util/Map.Entry.html#equals%28java.lang.Object%29) in interface [Map.Entry](../../java/util/Map.Entry.html "interface in java.util")<[K](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry"),[V](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry")>

Overrides:

[equals](../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Parameters:

o - object to be compared for equality with this map entry

Returns:

true if the specified object is equal to this map entry

See Also:

hashCode()

hashCode

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 thate1.hashCode()==e2.hashCode() for any two Entriese1 and e2, as required by the general contract of Object.hashCode().

Specified by:

[hashCode](../../java/util/Map.Entry.html#hashCode%28%29) in interface [Map.Entry](../../java/util/Map.Entry.html "interface in java.util")<[K](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry"),[V](../../java/util/AbstractMap.SimpleEntry.html "type parameter in AbstractMap.SimpleEntry")>

Overrides:

[hashCode](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

the hash code value for this map entry

See Also:

equals(java.lang.Object)

toString

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.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a String representation of this map entry

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.