Module platform
Package org.jfree.chart.axis

Class TickUnit

java.lang.Object
org.jfree.chart.axis.TickUnit
All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
DateTickUnit, NumberTickUnit
public abstract class TickUnit extends Object implements Comparable, 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.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TickUnit(double size)
    Constructs a new tick unit.
    TickUnit(double size, int minorTickCount)
    Constructs a new tick unit.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(Object object)
    Compares this tick unit to an arbitrary object.
    boolean
    equals(Object obj)
    Tests this unit for equality with another object.
    int
    getMinorTickCount()
    Returns the minor tick count.
    double
    getSize()
    Returns the size of the tick unit.
    int
    hashCode()
    Returns a hash code for this instance.
    String
    valueToString(double value)
    Converts the supplied value to a string.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TickUnit

      public TickUnit(double size)
      Constructs a new tick unit.
      Parameters:
      size - the tick unit size.

    • TickUnit

      public TickUnit(double size, int minorTickCount)
      Constructs a new tick unit.
      Parameters:
      size - the tick unit size.
      minorTickCount - the minor tick count.

  • Method Details

    • getSize

      public double getSize()
      Returns the size of the tick unit.
      Returns:
      The size of the tick unit.

    • getMinorTickCount

      public int getMinorTickCount()
      Returns the minor tick count.
      Returns:
      The minor tick count.

    • valueToString

      public 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(Object object)
      Compares this tick unit to an arbitrary object.
      Specified by:
      compareTo in interface 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(Object obj)
      Tests this unit for equality with another object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object.
      Returns:
      true or false.

    • hashCode

      public int hashCode()
      Returns a hash code for this instance.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code.