edu.umd.cloud9.util.map
Interface MapIF.Entry

Enclosing interface:

MapIF

public static interface MapIF.Entry

A map entry (key-value pair) for MapIF. The MapIF.entrySet method returns a collection-view of the map, whose elements are of this class. The only way to obtain a reference to a map entry is from the iterator of this collection-view. These MapIF.Entry objects are valid only for the duration of the iteration; more formally, the behavior of a map entry is undefined if the backing map has been modified after the entry was returned by the iterator, except through the setValue operation on the map entry.

Method Summary

boolean	equals(Object o) Compares the specified object with this entry for equality.
int	getKey() Returns the key corresponding to this entry.
float	getValue() Returns the value corresponding to this entry.
int	hashCode() Returns the hash code value for this map entry.
float	setValue(float value) Replaces the value corresponding to this entry with the specified value, and write through to the backing map.

Method Detail

getKey

int getKey()

Returns the key corresponding to this entry.

Returns:

the key corresponding to this entry

getValue

float getValue()

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:

the value corresponding to this entry

setValue

float setValue(float value)

Replaces the value corresponding to this entry with the specified value, and write through to the backing map. The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters:

value - new value to be stored in this entry

Returns:

old value corresponding to the entry

equals

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.

Overrides:

equals in class Object

Parameters:

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

Returns:

true if the specified object is equal to this map entry

hashCode

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() ˆ 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.

Overrides:

hashCode in class Object

Returns:

the hash code value for this map entry

See Also:

Object.hashCode(), Object.equals(Object), equals(Object)