org.jfree.data

Class KeyedObjects

public class KeyedObjects extends Object implements Cloneable, PublicCloneable, Serializable

A collection of (key, object) pairs.
Constructor Summary
KeyedObjects()
Creates a new collection (initially empty).
Method Summary
voidaddObject(Comparable key, Object object)
Adds a new object to the collection, or overwrites an existing object.
Objectclone()
Returns a clone of this object.
booleanequals(Object o)
Tests if this object is equal to another.
intgetIndex(Comparable key)
Returns the index for a given key.
intgetItemCount()
Returns the number of items (values) in the collection.
ComparablegetKey(int index)
Returns a key.
ListgetKeys()
Returns the keys.
ObjectgetObject(int item)
Returns an object.
ObjectgetObject(Comparable key)
Returns the object for a given key.
voidremoveValue(int index)
Removes a value from the collection.
voidremoveValue(Comparable key)
Removes a value from the collection.
voidsetObject(Comparable key, Object object)
Replaces an existing object, or adds a new object to the collection.

Constructor Detail

KeyedObjects

public KeyedObjects()
Creates a new collection (initially empty).

Method Detail

addObject

public void addObject(Comparable key, Object object)
Adds a new object to the collection, or overwrites an existing object. This is the same as the KeyedObjects method.

Parameters: key the key. object the object.

clone

public Object clone()
Returns a clone of this object.

Returns: A clone.

Throws: CloneNotSupportedException if there is a problem cloning.

equals

public boolean equals(Object o)
Tests if this object is equal to another.

Parameters: o the other object.

Returns: A boolean.

getIndex

public int getIndex(Comparable key)
Returns the index for a given key.

Parameters: key the key.

Returns: The index, or -1 if the key is unrecognised.

getItemCount

public int getItemCount()
Returns the number of items (values) in the collection.

Returns: The item count.

getKey

public Comparable getKey(int index)
Returns a key.

Parameters: index the item index (zero-based).

Returns: The row key.

Throws: IndexOutOfBoundsException if index is out of bounds.

getKeys

public List getKeys()
Returns the keys.

Returns: The keys (never null).

getObject

public Object getObject(int item)
Returns an object.

Parameters: item the item index (zero-based).

Returns: The object (null if the index is out of range).

getObject

public Object getObject(Comparable key)
Returns the object for a given key. If the key is not recognised, the method should return null.

Parameters: key the key.

Returns: The object (possibly null).

removeValue

public void removeValue(int index)
Removes a value from the collection.

Parameters: index the index of the item to remove.

removeValue

public void removeValue(Comparable key)
Removes a value from the collection.

Parameters: key the key of the item to remove.

setObject

public void setObject(Comparable key, Object object)
Replaces an existing object, or adds a new object to the collection. This is the same as the KeyedObjects method.

Parameters: key the key. object the object.