org.apache.commons.collections
Class DefaultMapEntry

java.lang.Object
  |
  +--org.apache.commons.collections.DefaultMapEntry

Direct Known Subclasses:

BeanMap.MyMapEntry

public class DefaultMapEntry

extends Object

implements Map.Entry

A default implementation of Map.Entry

Since:

1.0

Author:

James Strachan, Michael A. Smith

Constructor Summary

DefaultMapEntry()
Constructs a new DefaultMapEntry with a null key and null value.

DefaultMapEntry(Object key, Object value)
Constructs a new DefaultMapEntry with the given key and given value.

Method Summary

boolean	equals(Object o) Implemented per API documentation of Map.Entry.equals(Object)
Object	getKey() Returns the key.
Object	getValue() Returns the value.
int	hashCode() Implemented per API documentation of Map.Entry.hashCode()
void	setKey(Object key) Sets the key.
Object	setValue(Object value) Note that this method only sets the local reference inside this object and does not modify the original Map.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMapEntry

public DefaultMapEntry()

Constructs a new DefaultMapEntry with a null key and null value.

DefaultMapEntry

public DefaultMapEntry(Object key,
                       Object value)

Constructs a new DefaultMapEntry with the given key and given value.

Parameters:

key - the key for the entry, may be null

value - the value for the entyr, may be null

Method Detail

equals

public boolean equals(Object o)

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

Specified by:

equals in interface Map.Entry

Overrides:

equals in class Object

hashCode

public int hashCode()

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

Specified by:

hashCode in interface Map.Entry

Overrides:

hashCode in class Object

getKey

public Object getKey()

Returns the key.

Specified by:

getKey in interface Map.Entry

Returns:

the key

getValue

public Object getValue()

Returns the value.

Specified by:

getValue in interface Map.Entry

Returns:

the value

setKey

public void setKey(Object key)

Sets the key. This method does not modify any map.

Parameters:

key - the new key

setValue

public Object setValue(Object value)

Note that this method only sets the local reference inside this object and does not modify the original Map.

Specified by:

setValue in interface Map.Entry

Parameters:

value - the new value

Returns:

the old value of the value