org.jfree.chart.axis
Class TickUnit

java.lang.Object
  |
  +--org.jfree.chart.axis.TickUnit

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

Direct Known Subclasses:

DateTickUnit, NumberTickUnit

public abstract class TickUnit

extends java.lang.Object

implements java.lang.Comparable, java.io.Serializable

Base class representing a tick unit. This determines the spacing of the tick marks on an axis.

This class (and any subclasses) should be immutable, the reason being that ORDERED collections of tick units are maintained and if one instance can be changed, it may destroy the order of the collection that it belongs to. In addition, if the implementations are immutable, they can belong to multiple collections.

Author:

David Gilbert

See Also:

ValueAxis, Serialized Form

Constructor Summary

TickUnit(double size)
Constructs a new tick unit.

Method Summary

int	compareTo(java.lang.Object object) Compares this tick unit to an arbitrary object.
boolean	equals(java.lang.Object obj) Tests this unit for equality with another object.
double	getSize() Returns the size of the tick unit.
java.lang.String	valueToString(double value) Converts the supplied value to a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TickUnit

public TickUnit(double size)

Constructs a new tick unit.

Parameters:

size - the tick unit size.

Method Detail

getSize

public double getSize()

Returns the size of the tick unit.

Returns:

the size of the tick unit.

valueToString

public java.lang.String valueToString(double value)

Converts the supplied value to a string.

Subclasses may implement special formatting by overriding this method.

Parameters:

value - the data value.

Returns:

value as string.

compareTo

public int compareTo(java.lang.Object object)

Compares this tick unit to an arbitrary object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - the object to compare against.

Returns:

1 if the size of the other object is less than this, 0 if both have the same size and -1 this size is less than the others.

equals

public boolean equals(java.lang.Object obj)

Tests this unit for equality with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object.

Returns:

true or false.