Package org.jfree.data.time
Class RegularTimePeriod
java.lang.Object
org.jfree.data.time.RegularTimePeriod
- All Implemented Interfaces:
Comparable,MonthConstants,TimePeriod
- Direct Known Subclasses:
Day,FixedMillisecond,Hour,Millisecond,Minute,Month,Quarter,Second,Week,Year
public abstract class RegularTimePeriod extends Object implements TimePeriod, Comparable, MonthConstants
An abstract class representing a unit of time. Convenient methods are
provided for calculating the next and previous time periods. Conversion
methods are defined that return the first and last milliseconds of the time
period. The results from these methods are timezone dependent.
This class is immutable, and all subclasses should be immutable also.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description RegularTimePeriod() -
Method Summary
Modifier and Type Method Description static RegularTimePeriodcreateInstance(Class c, Date millisecond, TimeZone zone, Locale locale)Creates a time period that includes the specified millisecond, assuming the given time zone.static Classdownsize(Class c)Returns a subclass ofRegularTimePeriodthat is smaller than the specified class.DategetEnd()Returns the date/time that marks the end of the time period.abstract longgetFirstMillisecond()Returns the first millisecond of the time period.abstract longgetFirstMillisecond(Calendar calendar)Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).abstract longgetLastMillisecond()Returns the last millisecond of the time period.abstract longgetLastMillisecond(Calendar calendar)Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).longgetMiddleMillisecond()Returns the millisecond closest to the middle of the time period.longgetMiddleMillisecond(Calendar calendar)Returns the millisecond closest to the middle of the time period, evaluated using the supplied calendar (which incorporates a timezone).longgetMillisecond(TimePeriodAnchor anchor, Calendar calendar)Returns the millisecond (relative to the epoch) corresponding to the specifiedanchorusing the suppliedcalendar(which incorporates a time zone).abstract longgetSerialIndex()Returns a serial index number for the time unit.DategetStart()Returns the date/time that marks the start of the time period.abstract RegularTimePeriodnext()Returns the time period following this one, ornullif some limit has been reached.abstract voidpeg(Calendar calendar)Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).abstract RegularTimePeriodprevious()Returns the time period preceding this one, ornullif some lower limit has been reached.StringtoString()Returns a string representation of the time period.
-
Constructor Details
-
RegularTimePeriod
public RegularTimePeriod()
-
-
Method Details
-
createInstance
public static RegularTimePeriod createInstance(Class c, Date millisecond, TimeZone zone, Locale locale)Creates a time period that includes the specified millisecond, assuming the given time zone.- Parameters:
c- the time period class.millisecond- the time.zone- the time zone.locale- the locale.- Returns:
- The time period.
-
downsize
Returns a subclass ofRegularTimePeriodthat is smaller than the specified class.- Parameters:
c- a subclass ofRegularTimePeriod.- Returns:
- A class.
-
previous
Returns the time period preceding this one, ornullif some lower limit has been reached.- Returns:
- The previous time period (possibly
null).
-
next
Returns the time period following this one, ornullif some limit has been reached.- Returns:
- The next time period (possibly
null).
-
getSerialIndex
Returns a serial index number for the time unit.- Returns:
- The serial index number.
-
peg
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).- Parameters:
calendar- the calendar (nullnot permitted).- Since:
- 1.0.3
-
getStart
Returns the date/time that marks the start of the time period. This method returns a newDateinstance every time it is called.- Specified by:
getStartin interfaceTimePeriod- Returns:
- The start date/time.
- See Also:
getFirstMillisecond()
-
getEnd
Returns the date/time that marks the end of the time period. This method returns a newDateinstance every time it is called.- Specified by:
getEndin interfaceTimePeriod- Returns:
- The end date/time.
- See Also:
getLastMillisecond()
-
getFirstMillisecond
Returns the first millisecond of the time period. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to thepeg(Calendar)method.- Returns:
- The first millisecond of the time period.
- See Also:
getLastMillisecond()
-
getFirstMillisecond
Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).- Parameters:
calendar- the calendar (nullnot permitted).- Returns:
- The first millisecond of the time period.
- Throws:
NullPointerException- ifcalendarisnull.- See Also:
getLastMillisecond(Calendar)
-
getLastMillisecond
Returns the last millisecond of the time period. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to thepeg(Calendar)method.- Returns:
- The last millisecond of the time period.
- See Also:
getFirstMillisecond()
-
getLastMillisecond
Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).- Parameters:
calendar- the calendar (nullnot permitted).- Returns:
- The last millisecond of the time period.
- See Also:
getFirstMillisecond(Calendar)
-
getMiddleMillisecond
Returns the millisecond closest to the middle of the time period.- Returns:
- The middle millisecond.
-
getMiddleMillisecond
Returns the millisecond closest to the middle of the time period, evaluated using the supplied calendar (which incorporates a timezone).- Parameters:
calendar- the calendar.- Returns:
- The middle millisecond.
-
getMillisecond
Returns the millisecond (relative to the epoch) corresponding to the specifiedanchorusing the suppliedcalendar(which incorporates a time zone).- Parameters:
anchor- the anchor (nullnot permitted).calendar- the calendar (nullnot permitted).- Returns:
- Milliseconds since the epoch.
- Since:
- 1.0.18
-
toString
Returns a string representation of the time period.
-