org.jfree.chart.axis

Class TickUnits

Implemented Interfaces:
Cloneable, Serializable, TickUnitSource

public class TickUnits
extends java.lang.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

void
add(TickUnit unit)
Adds a tick unit to the collection.
Object
clone()
Returns a clone of the collection.
boolean
equals(Object object)
Tests an object for equality with this instance.
TickUnit
get(int pos)
Returns the tickunit on the given position.
TickUnit
getCeilingTickUnit(double size)
Returns the tick unit in the collection that is greater than or equal to the specified size.
TickUnit
getCeilingTickUnit(TickUnit unit)
Returns the tick unit in the collection that is greater than or equal to (in size) the specified unit.
TickUnit
getLargerTickUnit(TickUnit unit)
Returns a tick unit that is larger than the supplied unit.
int
size()
Returns the number of tick units in this collection.

Constructor Details

TickUnits

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

Method Details

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.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the collection.
Returns:
A clone.

equals

public boolean equals(Object object)
Tests an object for equality with this instance.
Parameters:
object - the object to test.
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(double size)
Returns the tick unit in the collection that is greater than or equal to the specified size.
Specified by:
getCeilingTickUnit in interface TickUnitSource
Parameters:
size - the size.
Returns:
A unit from the collection.

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.
Specified by:
getCeilingTickUnit in interface TickUnitSource
Parameters:
unit - the unit.
Returns:
A unit from the collection.

getLargerTickUnit

public TickUnit getLargerTickUnit(TickUnit unit)
Returns a tick unit that is larger than the supplied unit.
Specified by:
getLargerTickUnit in interface TickUnitSource
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.