Home » openjdk-7 » java » util » [javadoc | source]
java.util
public static class: AbstractMap.SimpleEntry [javadoc | source]
java.lang.Object
   java.util.AbstractMap$SimpleEntry

All Implemented Interfaces:
    Entry, Serializable

Direct Known Subclasses:
    WriteThroughEntry

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 method Map.entrySet().toArray.
Constructor:
 public SimpleEntry(Entry<? extends K, ? extends V> entry) 
    Creates an entry representing the same mapping as the specified entry.
    Parameters:
    entry - the entry to copy
 public SimpleEntry(K key,
    V value) 
Method from java.util.AbstractMap$SimpleEntry Summary:
equals,   getKey,   getValue,   hashCode,   setValue,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.AbstractMap$SimpleEntry Detail:
 public boolean equals(Object o) 
    Compares the specified object with this entry for equality. Returns {@code true} if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries {@code e1} and {@code 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 {@code equals} method works properly across different implementations of the {@code Map.Entry} interface.
 public K getKey() 
    Returns the key corresponding to this entry.
 public V getValue() 
    Returns the value corresponding to this entry.
 public int hashCode() 
    Returns the hash code value for this map entry. The hash code of a map entry {@code e} is defined to be:
      (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
      (e.getValue()==null ? 0 : e.getValue().hashCode())
    This ensures that {@code e1.equals(e2)} implies that {@code e1.hashCode()==e2.hashCode()} for any two Entries {@code e1} and {@code e2}, as required by the general contract of Object#hashCode .
 public V setValue(V value) 
    Replaces the value corresponding to this entry with the specified value.
 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.