org.jfree.data

Class ComparableObjectItem

public class ComparableObjectItem extends Object implements Cloneable, Comparable, Serializable

Represents one (Comparable, Object) data item for use in a ComparableObjectSeries.

Since: 1.0.3

Constructor Summary
ComparableObjectItem(Comparable x, Object y)
Constructs a new data item.
Method Summary
Objectclone()
Returns a clone of this object.
intcompareTo(Object o1)
Returns an integer indicating the order of this object relative to another object.
booleanequals(Object obj)
Tests if this object is equal to another.
protected ComparablegetComparable()
Returns the x-value.
protected ObjectgetObject()
Returns the y-value.
inthashCode()
Returns a hash code.
protected voidsetObject(Object y)
Sets the y-value for this data item.

Constructor Detail

ComparableObjectItem

public ComparableObjectItem(Comparable x, Object y)
Constructs a new data item.

Parameters: x the x-value (null NOT permitted). y the y-value (null permitted).

Method Detail

clone

public Object clone()
Returns a clone of this object.

Returns: A clone.

Throws: CloneNotSupportedException not thrown by this class, but subclasses may differ.

compareTo

public int compareTo(Object o1)
Returns an integer indicating the order of this object relative to another object.

For the order we consider only the x-value: negative == "less-than", zero == "equal", positive == "greater-than".

Parameters: o1 the object being compared to.

Returns: An integer indicating the order of this data pair object relative to another object.

equals

public boolean equals(Object obj)
Tests if this object is equal to another.

Parameters: obj the object to test against for equality (null permitted).

Returns: A boolean.

getComparable

protected Comparable getComparable()
Returns the x-value.

Returns: The x-value (never null).

getObject

protected Object getObject()
Returns the y-value.

Returns: The y-value (possibly null).

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

setObject

protected void setObject(Object y)
Sets the y-value for this data item. Note that there is no corresponding method to change the x-value.

Parameters: y the new y-value (null permitted).