structure
Class Entry

java.lang.Object
  |
  +--structure.Entry
All Implemented Interfaces:
java.util.Map.Entry

public class Entry
extends java.lang.Object
implements java.util.Map.Entry

An implementation of the the java.util.Map.Entry interface, Entry is a simple key value pair, from which both the key and the value can be accessed. Association and related classes also implement the Map interface and have expanded functionality.

Typical Usage:

 ...
     Entry e = new Entry(aKey, aValue);
     Object key = e.getKey();
     Object value = e.getValue();
     e.setValue(newValue);
 ...
 


Field Summary
protected  java.lang.Object theKey
           
protected  java.lang.Object theValue
          The mutable value.
 
Constructor Summary
Entry(java.lang.Object key)
          Constructs a pair from a key; value is null.
Entry(java.lang.Object key, java.lang.Object value)
          Constructs a pair from a key and value.
 
Method Summary
 boolean equals(java.lang.Object other)
          Standard comparison function.
 java.lang.Object getKey()
          Fetch key from association.
 java.lang.Object getValue()
          Fetch value from association.
 int hashCode()
          Standard hashcode function.
 java.lang.Object setValue(java.lang.Object value)
          Sets the value of the key-value pair.
 java.lang.String toString()
          Standard string representation of an association.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

theKey

protected java.lang.Object theKey

theValue

protected java.lang.Object theValue
The mutable value. An arbitrary object.

Constructor Detail

Entry

public Entry(java.lang.Object key,
             java.lang.Object value)
Constructs a pair from a key and value.

Parameters:
key - A non-null object.
value - A (possibly null) object.

Entry

public Entry(java.lang.Object key)
Constructs a pair from a key; value is null.

Parameters:
key - A non-null key value.
Method Detail

equals

public boolean equals(java.lang.Object other)
Standard comparison function. Comparison based on keys only.

Specified by:
equals in interface java.util.Map.Entry
Overrides:
equals in class java.lang.Object
Parameters:
other - Another association.
Returns:
True iff the keys are equal.

hashCode

public int hashCode()
Standard hashcode function.

Specified by:
hashCode in interface java.util.Map.Entry
Overrides:
hashCode in class java.lang.Object
Returns:
A hash code for association.
See Also:
Hashtable

getValue

public java.lang.Object getValue()
Fetch value from association. May return null.

Specified by:
getValue in interface java.util.Map.Entry
Returns:
The value field of the association.

getKey

public java.lang.Object getKey()
Fetch key from association. Should not return null.

Specified by:
getKey in interface java.util.Map.Entry
Returns:
Key of the key-value pair.

setValue

public java.lang.Object setValue(java.lang.Object value)
Sets the value of the key-value pair.

Specified by:
setValue in interface java.util.Map.Entry
Parameters:
value - The new value.

toString

public java.lang.String toString()
Standard string representation of an association.

Overrides:
toString in class java.lang.Object
Returns:
String representing key-value pair.