public class

KeyedObjects

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.data.KeyedObjects

Class Overview

A collection of (key, object) pairs.

Summary

Public Constructors
KeyedObjects()
Creates a new collection (initially empty).
Public Methods
void addObject(Comparable key, Object object)
Adds a new object to the collection, or overwrites an existing object.
void clear()
Clears all values from the collection.
Object clone()
Returns a clone of this object.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
int getIndex(Comparable key)
Returns the index for a given key, or -1.
int getItemCount()
Returns the number of items (values) in the collection.
Comparable getKey(int index)
Returns the key at the specified position in the list.
List getKeys()
Returns a list containing all the keys in the list.
Object getObject(Comparable key)
Returns the object for a given key.
Object getObject(int item)
Returns an object from the list.
int hashCode()
Returns a hash code.
void insertValue(int position, Comparable key, Object value)
Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public KeyedObjects ()

Creates a new collection (initially empty).

Public Methods

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.
See Also

public void clear ()

Clears all values from the collection.

public Object clone ()

Returns a clone of this object. Keys in the list should be immutable and are not cloned. Objects in the list are cloned only if they implement PublicCloneable.

Returns
  • A clone.
Throws
CloneNotSupportedException if there is a problem cloning.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public int getIndex (Comparable key)

Returns the index for a given key, or -1.

Parameters
key the key (null not permitted).
Returns
  • The index, or -1 if the key is unrecognised.
See Also

public int getItemCount ()

Returns the number of items (values) in the collection.

Returns
  • The item count.

public Comparable getKey (int index)

Returns the key at the specified position in the list.

Parameters
index the item index (zero-based).
Returns
  • The row key.
Throws
IndexOutOfBoundsException if item is out of bounds.
See Also

public List getKeys ()

Returns a list containing all the keys in the list.

Returns
  • The keys (never null).

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

public Object getObject (int item)

Returns an object from the list.

Parameters
item the item index (zero-based).
Returns
  • The object (possibly null).
Throws
IndexOutOfBoundsException if item is out of bounds.

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public void insertValue (int position, Comparable key, Object value)

Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.

Parameters
position the position (in the range 0 to getItemCount()).
key the key (null not permitted).
value the value (null permitted).

public void removeValue (Comparable key)

Removes a value from the collection.

Parameters
key the key (null not permitted).
Throws
UnknownKeyException if the key is not recognised.
See Also

public void removeValue (int index)

Removes a value from the collection.

Parameters
index the index of the item to remove.
See Also

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 (null not permitted).
object the object.
See Also