Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data

Class KeyedObjects

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable
public class KeyedObjects
extends java.lang.Object
implements Cloneable, PublicCloneable, Serializable
A collection of (key, object) pairs.

Constructor Summary

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

Method Summary

void
addObject(Comparable key, Object object)
Adds a new object to the collection, or overwrites an existing object.
Object
clone()
Returns a clone of this object.
boolean
equals(Object o)
Tests if this object is equal to another.
int
getIndex(Comparable key)
Returns the index for a given key.
int
getItemCount()
Returns the number of items (values) in the collection.
Comparable
getKey(int index)
Returns a key.
List
getKeys()
Returns the keys.
Object
getObject(Comparable key)
Returns the object for a given key.
Object
getObject(int item)
Returns an object.
void
removeValue(Comparable key)
Removes a value from the collection.
void
removeValue(int index)
Removes a value from the collection.
void
setObject(Comparable key, Object object)
Replaces an existing object, or adds a new object to the collection.

Constructor Details

KeyedObjects

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

Method Details

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 setObject(Comparable,Object) method.
Parameters:
key - the key.
object - the object.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this object.
Returns:
A clone.

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.

getKeys

public List getKeys()
Returns the keys.
Returns:
The keys (never null).

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).

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).

removeValue

public void removeValue(Comparable key)
Removes a value from the collection.
Parameters:
key - the key of the item to remove.

removeValue

public void removeValue(int index)
Removes a value from the collection.
Parameters:
index - the index 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 addObject(Comparable,Object) method.
Parameters:
key - the key.
object - the object.

Overview Package Class Use Source Tree Index Deprecated About