Module platform
Package org.jfree.data.xy

Class XYItemKey<S extends Comparable<S>>

java.lang.Object
org.jfree.data.xy.XYItemKey<S>
Type Parameters:
S - the series key type.
All Implemented Interfaces:
Serializable, Comparable<XYItemKey<S>>, ItemKey
public class XYItemKey<S extends Comparable<S>> extends Object implements ItemKey, Comparable<XYItemKey<S>>, Serializable
An object that references one data item in an XYZDataset. This is used internally to track the data item that a 3D object is related to, if any (and later that link is used for chart interaction). Instances of this class are immutable.
See Also:

  • Constructor Details

    • XYItemKey

      public XYItemKey(S seriesKey, int itemIndex)
      Creates a new instance.
      Parameters:
      seriesKey - the series key.
      itemIndex - the item index.

  • Method Details

    • getSeriesKey

      public S getSeriesKey()
      Returns the series key.
      Returns:
      The series key (never null).

    • getItemIndex

      public int getItemIndex()
      Returns the item index.
      Returns:
      The item index.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toJSONString

      public String toJSONString()
      Description copied from interface: ItemKey
      Returns a JSON formatted string representing the key.
      Specified by:
      toJSONString in interface ItemKey
      Returns:
      A JSON formatted string.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(XYItemKey<S> key)
      Specified by:
      compareTo in interface Comparable<S extends Comparable<S>>