This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.util
class AbstractMap.SimpleImmutableEntry

java.lang.Object extended by java.util.AbstractMap.SimpleImmutableEntry
All Implemented Interfaces:
Serializable, Map.Entry
Enclosing class:
AbstractMap

public static class AbstractMap.SimpleImmutableEntry
extends Object
implements Map.Entry, Serializable

An Entry maintaining an immutable key and value. This class does not support method setValue. This class may be convenient in methods that return thread-safe snapshots of key-value mappings.


Constructor Summary

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

          Creates an entry representing the same mapping as the specified entry.
 
Method Summary
 boolean

          Compares the specified object with this entry for equality.
 Object

          Returns the key corresponding to this entry.
 Object

          Returns the value corresponding to this entry.
 int

          Returns the hash code value for this map entry.
 Object

          Replaces the value corresponding to this entry with the specified value (optional operation).
 String

          Returns a String representation of this map entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractMap.SimpleImmutableEntry

public AbstractMap.SimpleImmutableEntry(Object key,
                                        Object 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.SimpleImmutableEntry

public AbstractMap.SimpleImmutableEntry(Map.Entry entry)
Creates an entry representing the same mapping as the specified entry.

Parameters:
entry - the entry to copy
Method Detail

equals

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.

Overrides:
equals in class Object
Parameters:
o - object to be compared for equality with this map entry
Returns:
{@code true} if the specified object is equal to this map entry

getKey

public Object getKey()
Returns the key corresponding to this entry.

Returns:
the key corresponding to this entry

getValue

public Object getValue()
Returns the value corresponding to this entry.

Returns:
the value corresponding to this entry

hashCode

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 {@link Object#hashCode}.

Overrides:
hashCode in class Object
Returns:
the hash code value for this map entry

setValue

public Object setValue(Object value)
Replaces the value corresponding to this entry with the specified value (optional operation). This implementation simply throws UnsupportedOperationException, as this class implements an immutable map entry.

Parameters:
value - new value to be stored in this entry
Returns:
(Does not return)

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 in class Object
Returns:
a String representation of this map entry


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.