public class

DefaultKeyValue

extends AbstractKeyValue
java.lang.Object
   ↳ org.apache.commons.collections.keyvalue.AbstractKeyValue
     ↳ org.apache.commons.collections.keyvalue.DefaultKeyValue

Class Overview

A mutable KeyValue pair that does not implement java.util.Map.Entry Map.Entry.

Note that a DefaultKeyValue instance may not contain itself as a key or value.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.keyvalue.AbstractKeyValue
Public Constructors
DefaultKeyValue()
Constructs a new pair with a null key and null value.
DefaultKeyValue(Object key, Object value)
Constructs a new pair with the specified key and given value.
DefaultKeyValue(KeyValue pair)
Constructs a new pair from the specified KeyValue.
DefaultKeyValue(Entry entry)
Constructs a new pair from the specified Map.Entry.
Public Methods
boolean equals(Object obj)
Compares this Map.Entry with another Map.Entry.
int hashCode()
Gets a hashCode compatible with the equals method.
Object setKey(Object key)
Sets the key.
Object setValue(Object value)
Sets the value.
Entry toMapEntry()
Returns a new Map.Entry object with key and value from this pair.
[Expand]
Inherited Methods
From class org.apache.commons.collections.keyvalue.AbstractKeyValue
From class java.lang.Object
From interface org.apache.commons.collections.KeyValue

Public Constructors

public DefaultKeyValue ()

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

public DefaultKeyValue (Object key, Object value)

Constructs a new pair with the specified key and given value.

Parameters
key the key for the entry, may be null
value the value for the entry, may be null

public DefaultKeyValue (KeyValue pair)

Constructs a new pair from the specified KeyValue.

Parameters
pair the pair to copy, must not be null
Throws
NullPointerException if the entry is null

public DefaultKeyValue (Entry entry)

Constructs a new pair from the specified Map.Entry.

Parameters
entry the entry to copy, must not be null
Throws
NullPointerException if the entry is null

Public Methods

public boolean equals (Object obj)

Compares this Map.Entry with another Map.Entry.

Returns true if the compared object is also a DefaultKeyValue, and its key and value are equal to this object's key and value.

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

public int hashCode ()

Gets a hashCode compatible with the equals method.

Implemented per API documentation of hashCode(), however subclasses may override this.

Returns
  • a suitable hash code

public Object setKey (Object key)

Sets the key.

Parameters
key the new key
Returns
  • the old key
Throws
IllegalArgumentException if key is this object

public Object setValue (Object value)

Sets the value.

Parameters
value the new value
Returns
  • the old value of the value
Throws
IllegalArgumentException if value is this object

public Entry toMapEntry ()

Returns a new Map.Entry object with key and value from this pair.

Returns
  • a MapEntry instance