Package org.jfree.chart.axis
Class DateTickUnit
java.lang.Object
org.jfree.chart.axis.TickUnit
org.jfree.chart.axis.DateTickUnit
- All Implemented Interfaces:
Serializable
,Comparable
A tick unit for use by subclasses of
DateAxis
. Instances of this
class are immutable.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
The unit count.private DateFormat
The date formatter.private int
The roll count.private DateTickUnitType
The roll unit type.private static final long
For serialization.private DateTickUnitType
The units. -
Constructor Summary
ConstructorsConstructorDescriptionDateTickUnit
(DateTickUnitType unitType, int multiple) Creates a new date tick unit.DateTickUnit
(DateTickUnitType unitType, int multiple, DateFormat formatter) Creates a new date tick unit.DateTickUnit
(DateTickUnitType unitType, int multiple, DateTickUnitType rollUnitType, int rollMultiple, DateFormat formatter) Creates a new unit. -
Method Summary
Modifier and TypeMethodDescriptionCalculates a new date by adding this unit to the base date.dateToString
(Date date) Formats a date using the tick unit's formatter.boolean
Tests this unit for equality with another object.int
Returns a field code that can be used with theCalendar
class.private static long
getMillisecondCount
(DateTickUnitType unit, int count) Returns the (approximate) number of milliseconds for the given unit and unit count.int
Returns the unit multiple.int
Returns the roll unit multiple.Returns the roll unit type.Returns the unit type.int
hashCode()
Returns a hash code for this object.Rolls the date forward by the amount specified by the roll unit and count.Rolls the date forward by the amount specified by the roll unit and count.toString()
Returns a string representation of this instance, primarily used for debugging purposes.valueToString
(double milliseconds) Formats a value.Methods inherited from class org.jfree.chart.axis.TickUnit
compareTo, getMinorTickCount, getSize
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor serialization.- See Also:
-
unitType
The units. -
count
private int countThe unit count. -
rollUnitType
The roll unit type. -
rollCount
private int rollCountThe roll count. -
formatter
The date formatter.
-
-
Constructor Details
-
DateTickUnit
Creates a new date tick unit.- Parameters:
unitType
- the unit type (null
not permitted).multiple
- the multiple (of the unit type, must be > 0).
-
DateTickUnit
Creates a new date tick unit.- Parameters:
unitType
- the unit type (null
not permitted).multiple
- the multiple (of the unit type, must be > 0).formatter
- the date formatter (null
not permitted).
-
DateTickUnit
public DateTickUnit(DateTickUnitType unitType, int multiple, DateTickUnitType rollUnitType, int rollMultiple, DateFormat formatter) Creates a new unit.- Parameters:
unitType
- the unit.multiple
- the multiple.rollUnitType
- the roll unit.rollMultiple
- the roll multiple.formatter
- the date formatter (null
not permitted).
-
-
Method Details
-
getUnitType
Returns the unit type.- Returns:
- The unit type (never
null
).
-
getMultiple
public int getMultiple()Returns the unit multiple.- Returns:
- The unit multiple (always > 0).
-
getRollUnitType
Returns the roll unit type.- Returns:
- The roll unit type (never
null
).
-
getRollMultiple
public int getRollMultiple()Returns the roll unit multiple.- Returns:
- The roll unit multiple.
-
valueToString
Formats a value.- Overrides:
valueToString
in classTickUnit
- Parameters:
milliseconds
- date in milliseconds since 01-01-1970.- Returns:
- The formatted date.
-
dateToString
Formats a date using the tick unit's formatter.- Parameters:
date
- the date.- Returns:
- The formatted date.
-
addToDate
Calculates a new date by adding this unit to the base date.- Parameters:
base
- the base date.zone
- the time zone for the date calculation.- Returns:
- A new date one unit after the base date.
-
rollDate
Rolls the date forward by the amount specified by the roll unit and count.- Parameters:
base
- the base date.- Returns:
- The rolled date.
- See Also:
-
rollDate
Rolls the date forward by the amount specified by the roll unit and count.- Parameters:
base
- the base date.zone
- the time zone.- Returns:
- The rolled date.
-
getCalendarField
public int getCalendarField()Returns a field code that can be used with theCalendar
class.- Returns:
- The field code.
-
getMillisecondCount
Returns the (approximate) number of milliseconds for the given unit and unit count.This value is an approximation some of the time (e.g. months are assumed to have 31 days) but this shouldn't matter.
- Parameters:
unit
- the unit.count
- the unit count.- Returns:
- The number of milliseconds.
-
equals
Tests this unit for equality with another object. -
hashCode
public int hashCode()Returns a hash code for this object. -
toString
Returns a string representation of this instance, primarily used for debugging purposes.
-