Class KeyedObjects

    • Constructor Detail

      • KeyedObjects

        public KeyedObjects()
        Creates a new collection (initially empty).
    • Method Detail

      • 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 from the list.
        Parameters:
        item - the item index (zero-based).
        Returns:
        The object (possibly null).
        Throws:
        IndexOutOfBoundsException - if item is out of bounds.
      • getIndex

        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:
        getKey(int)
      • getKeys

        public List getKeys()
        Returns a list containing all the keys in the list.
        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).
        See Also:
        addObject(Comparable, Object)
      • insertValue

        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).
        Since:
        1.0.7
      • removeValue

        public void removeValue​(int index)
        Removes a value from the collection.
        Parameters:
        index - the index of the item to remove.
        See Also:
        removeValue(Comparable)
      • removeValue

        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:
        removeValue(int)
      • clear

        public void clear()
        Clears all values from the collection.
        Since:
        1.0.7
      • clone

        public Object clone()
                     throws CloneNotSupportedException
        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.
        Specified by:
        clone in interface org.jfree.util.PublicCloneable
        Overrides:
        clone in class Object
        Returns:
        A clone.
        Throws:
        CloneNotSupportedException - if there is a problem cloning.
      • equals

        public boolean equals​(Object obj)
        Tests this object for equality with an arbitrary object.
        Overrides:
        equals in class Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • hashCode

        public int hashCode()
        Returns a hash code.
        Overrides:
        hashCode in class Object
        Returns:
        A hash code.