java.util
Class TreeMap.Entry

java.lang.Object
  java.util.TreeMap.Entry

All Implemented Interfaces:

Map.Entry

Enclosing class:

TreeMap

static class TreeMap.Entry

extends Object

implements Map.Entry

Node in the Tree. Doubles as a means to pass key-value pairs back to user (see Map.Entry).

Field Summary

(package private) boolean	color
(package private) Object	key
(package private) TreeMap.Entry	left
(package private) TreeMap.Entry	parent
(package private) TreeMap.Entry	right
(package private) Object	value

Constructor Summary

(package private)

TreeMap.Entry(Object key, Object value, TreeMap.Entry parent) Make a new cell with given key, value, and parent, and with null child links, and BLACK color.

Method Summary

boolean	equals(Object o) Compares the specified object with this entry for equality.
Object	getKey() Returns the key.
Object	getValue() Returns the value associated with the key.
int	hashCode() Returns the hash code value for this map entry.
Object	setValue(Object value) Replaces the value currently associated with the key with the given value.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

key

Object key

value

Object value

left

TreeMap.Entry left

right

TreeMap.Entry right

parent

TreeMap.Entry parent

color

boolean color

Constructor Detail

TreeMap.Entry

TreeMap.Entry(Object key,
              Object value,
              TreeMap.Entry parent)

Make a new cell with given key, value, and parent, and with null child links, and BLACK color.

Method Detail

getKey

public Object getKey()

Returns the key.

Specified by:

getKey in interface Map.Entry

Returns:

the key.

getValue

public Object getValue()

Returns the value associated with the key.

Specified by:

getValue in interface Map.Entry

Returns:

the value associated with the key.

setValue

public Object setValue(Object value)

Replaces the value currently associated with the key with the given value.

Specified by:

setValue in interface Map.Entry

Parameters:

value - new value to be stored in this entry.

Returns:

the value associated with the key before this method was called.

equals

public boolean equals(Object o)

Description copied from interface: Map.Entry

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 in interface Map.Entry

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from interface: Map.Entry

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.

Specified by:

hashCode in interface Map.Entry

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Overrides:

toString in class Object

Returns:

a string representation of the object.