org.apache.commons.collections4.keyvalue
Class AbstractKeyValue<K,V>

java.lang.Object
  extended by org.apache.commons.collections4.keyvalue.AbstractKeyValue<K,V>
All Implemented Interfaces:
KeyValue<K,V>
Direct Known Subclasses:
AbstractMapEntry, DefaultKeyValue

public abstract class AbstractKeyValue<K,V>
extends Object
implements KeyValue<K,V>

Abstract pair class to assist with creating KeyValue and Map.Entry implementations.

Since:
3.0
Version:
$Id: AbstractKeyValue.java 1477753 2013-04-30 18:24:24Z tn $

Constructor Summary
protected AbstractKeyValue(K key, V value)
          Constructs a new pair with the specified key and given value.
 
Method Summary
 K getKey()
          Gets the key from the pair.
 V getValue()
          Gets the value from the pair.
protected  K setKey(K key)
           
protected  V setValue(V value)
           
 String toString()
          Gets a debugging String view of the pair.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractKeyValue

protected AbstractKeyValue(K key,
                           V 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
Method Detail

getKey

public K getKey()
Gets the key from the pair.

Specified by:
getKey in interface KeyValue<K,V>
Returns:
the key

setKey

protected K setKey(K key)

getValue

public V getValue()
Gets the value from the pair.

Specified by:
getValue in interface KeyValue<K,V>
Returns:
the value

setValue

protected V setValue(V value)

toString

public String toString()
Gets a debugging String view of the pair.

Overrides:
toString in class Object
Returns:
a String view of the entry


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.