org.apache.commons.collections.keyvalue

Class TiedMapEntry

Implemented Interfaces:
Map.Entry, KeyValue, Serializable

public class TiedMapEntry
extends java.lang.Object
implements Map.Entry, KeyValue, Serializable

A Map Entry tied to a map underneath.

This can be used to enable a map entry to make changes on the underlying map, however this will probably mess up any iterators.

Version:
$Revision: 1.5 $ $Date: 2004/04/09 14:35:10 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Constructor Summary

TiedMapEntry(Map map, Object key)
Constructs a new entry with the given Map and key.

Method Summary

boolean
equals(Object obj)
Compares this Map Entry with another Map Entry.
Object
getKey()
Gets the key of this entry
Object
getValue()
Gets the value of this entry direct from the map.
int
hashCode()
Gets a hashCode compatible with the equals method.
Object
setValue(Object value)
Sets the value associated with the key direct onto the map.
String
toString()
Gets a string version of the entry.

Constructor Details

TiedMapEntry

public TiedMapEntry(Map map,
                    Object key)
Constructs a new entry with the given Map and key.
Parameters:
map - the map
key - the key

Method Details

equals

public boolean equals(Object obj)
Compares this Map Entry with another Map Entry.

Implemented per API documentation of java.util.Map.Entry.equals(Object)

Parameters:
obj - the object to compare to
Returns:
true if equal key and value

getKey

public Object getKey()
Gets the key of this entry
Specified by:
getKey in interface KeyValue
Returns:
the key

getValue

public Object getValue()
Gets the value of this entry direct from the map.
Specified by:
getValue in interface KeyValue
Returns:
the value

hashCode

public int hashCode()
Gets a hashCode compatible with the equals method.

Implemented per API documentation of java.util.Map.Entry.hashCode()

Returns:
a suitable hash code

setValue

public Object setValue(Object value)
Sets the value associated with the key direct onto the map.
Parameters:
value - the new value
Returns:
the old value

toString

public String toString()
Gets a string version of the entry.
Returns:
entry as a string

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.