org.apache.commons.collections.keyvalue

Class AbstractKeyValue

Implemented Interfaces:
KeyValue
Known Direct Subclasses:
AbstractMapEntry, DefaultKeyValue

public abstract class AbstractKeyValue
extends Object
implements KeyValue

Abstract pair class to assist with creating KeyValue and MapEntry implementations.

Version:
$Revision: 1.3 $ $Date: 2004/02/18 01:00:08 $

Authors:
James Strachan
Michael A. Smith
Neil O'Toole
Stephen Colebourne

Since:
Commons Collections 3.0

Field Summary

protected Object
key
The key
protected Object
value
The value

Constructor Summary

AbstractKeyValue(Object key, Object value)
Constructs a new pair with the specified key and given value.

Method Summary

Object
getKey()
Gets the key from the pair.
Object
getValue()
Gets the value from the pair.
String
toString()
Gets a debugging String view of the pair.

Field Details

key

protected Object key
The key


value

protected Object value
The value

Constructor Details

AbstractKeyValue

protected AbstractKeyValue(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

Method Details

getKey

public Object getKey()
Gets the key from the pair.
Specified by:
getKey in interface KeyValue

Returns:
the key


getValue

public Object getValue()
Gets the value from the pair.
Specified by:
getValue in interface KeyValue

Returns:
the value


toString

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

Returns:
a String view of the entry


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