org.jfree.chart.axis

Class TickUnits

public class TickUnits extends Object implements TickUnitSource, Cloneable, Serializable

A collection of tick units, used by the DateAxis and NumberAxis classes.
Constructor Summary
TickUnits()
Constructs a new collection of tick units.
Method Summary
voidadd(TickUnit unit)
Adds a tick unit to the collection.
Objectclone()
Returns a clone of the collection.
booleanequals(Object obj)
Tests an object for equality with this instance.
TickUnitget(int pos)
Returns the tickunit on the given position.
TickUnitgetCeilingTickUnit(TickUnit unit)
Returns the tick unit in the collection that is greater than or equal to (in size) the specified unit.
TickUnitgetCeilingTickUnit(double size)
Returns the tick unit in the collection that is greater than or equal to the specified size.
TickUnitgetLargerTickUnit(TickUnit unit)
Returns a tick unit that is larger than the supplied unit.
intsize()
Returns the number of tick units in this collection.

Constructor Detail

TickUnits

public TickUnits()
Constructs a new collection of tick units.

Method Detail

add

public void add(TickUnit unit)
Adds a tick unit to the collection. The tick units are maintained in ascending order.

Parameters: unit the tick unit to add (null not permitted).

clone

public Object clone()
Returns a clone of the collection.

Returns: A clone.

Throws: CloneNotSupportedException if an item in the collection does not support cloning.

equals

public boolean equals(Object obj)
Tests an object for equality with this instance.

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

Returns: A boolean.

get

public TickUnit get(int pos)
Returns the tickunit on the given position.

This method is required for the XML writer.

Parameters: pos the position in the list.

Returns: The tickunit.

getCeilingTickUnit

public TickUnit getCeilingTickUnit(TickUnit unit)
Returns the tick unit in the collection that is greater than or equal to (in size) the specified unit.

Parameters: unit the unit.

Returns: A unit from the collection.

getCeilingTickUnit

public TickUnit getCeilingTickUnit(double size)
Returns the tick unit in the collection that is greater than or equal to the specified size.

Parameters: size the size.

Returns: A unit from the collection.

getLargerTickUnit

public TickUnit getLargerTickUnit(TickUnit unit)
Returns a tick unit that is larger than the supplied unit.

Parameters: unit the unit.

Returns: A tick unit that is larger than the supplied unit.

size

public int size()
Returns the number of tick units in this collection.

This method is required for the XML writer.

Returns: The number of units in this collection.