Package org.jfree.data

Class KeyedObjects

java.lang.Object
org.jfree.data.KeyedObjects
All Implemented Interfaces:
Serializable, Cloneable, org.jfree.util.PublicCloneable
public class KeyedObjects
extends Object
implements Cloneable, org.jfree.util.PublicCloneable, Serializable
A collection of (key, object) pairs.
See Also:
Serialized Form

  • Constructor Details

    • KeyedObjects

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

  • Method Details

    • getItemCount

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

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

    • getKey

      public Comparable getKey​(int index)
      Returns a key.
      Parameters:
      index - the item index (zero-based).
      Returns:
      the row key.

    • getIndex

      public int getIndex​(Comparable key)
      Returns the index for a given key.
      Parameters:
      key - the key.
      Returns:
      the index.

    • getKeys

      public List getKeys()
      Returns the keys.
      Returns:
      the keys.

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

    • 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(...) method.

      Parameters:
      key - the key.
      object - the object.

    • 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(...) method.

      Parameters:
      key - the key.
      object - the object.

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of this object.
      Specified by:
      clone in interface org.jfree.util.PublicCloneable
      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.
      Overrides:
      equals in class Object
      Parameters:
      o - the other object.
      Returns:
      A boolean.