public abstract class

RegularTimePeriod

extends Object
implements Comparable<T> TimePeriod
java.lang.Object
   ↳ org.jfree.data.time.RegularTimePeriod
Known Direct Subclasses

Class Overview

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.

Summary

Fields
public static final TimeZone DEFAULT_TIME_ZONE This field is deprecated. As of 1.0.11, we discourage the use of this field - use getDefault() instead.
public static final Calendar WORKING_CALENDAR This field is deprecated. This was a bad idea, don't use it!
Public Constructors
RegularTimePeriod()
Public Methods
static RegularTimePeriod createInstance(Class c, Date millisecond, TimeZone zone)
Creates a time period that includes the specified millisecond, assuming the given time zone.
static Class downsize(Class c)
Returns a subclass of RegularTimePeriod that is smaller than the specified class.
Date getEnd()
Returns the date/time that marks the end of the time period.
abstract long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
long getFirstMillisecond(TimeZone zone)
This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getFirstMillisecond(Calendar) instead.
abstract long getFirstMillisecond()
Returns the first millisecond of the time period.
long getLastMillisecond(TimeZone zone)
This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getLastMillisecond(Calendar) instead.
abstract long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
abstract long getLastMillisecond()
Returns the last millisecond of the time period.
long getMiddleMillisecond(Calendar calendar)
Returns the millisecond closest to the middle of the time period, evaluated using the supplied calendar (which incorporates a timezone).
long getMiddleMillisecond()
Returns the millisecond closest to the middle of the time period.
long getMiddleMillisecond(TimeZone zone)
This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getMiddleMillisecond(Calendar) instead.
abstract long getSerialIndex()
Returns a serial index number for the time unit.
Date getStart()
Returns the date/time that marks the start of the time period.
abstract RegularTimePeriod next()
Returns the time period following this one, or null if some limit has been reached.
abstract void peg(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 RegularTimePeriod previous()
Returns the time period preceding this one, or null if some lower limit has been reached.
String toString()
Returns a string representation of the time period.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable
From interface org.jfree.data.time.TimePeriod

Fields

public static final TimeZone DEFAULT_TIME_ZONE

This field is deprecated.
As of 1.0.11, we discourage the use of this field - use getDefault() instead.

The default time zone.

public static final Calendar WORKING_CALENDAR

This field is deprecated.
This was a bad idea, don't use it!

A working calendar (recycle to avoid unnecessary object creation).

Public Constructors

public RegularTimePeriod ()

Public Methods

public static RegularTimePeriod createInstance (Class c, Date millisecond, TimeZone zone)

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.
Returns
  • The time period.

public static Class downsize (Class c)

Returns a subclass of RegularTimePeriod that is smaller than the specified class.

Parameters
c a subclass of RegularTimePeriod.
Returns
  • A class.

public Date getEnd ()

Returns the date/time that marks the end of the time period. This method returns a new Date instance every time it is called.

Returns
  • The end date/time.
See Also

public abstract long getFirstMillisecond (Calendar calendar)

Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).

Parameters
calendar the calendar (null not permitted).
Returns
  • The first millisecond of the time period.
Throws
NullPointerException if calendar,/code> is null.
See Also

public long getFirstMillisecond (TimeZone zone)

This method is deprecated.
As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getFirstMillisecond(Calendar) instead.

Returns the first millisecond of the time period, evaluated within a specific time zone.

Parameters
zone the time zone (null not permitted).
Returns
  • The first millisecond of the time period.
See Also

public abstract long 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 the peg(Calendar) method.

Returns
  • The first millisecond of the time period.
See Also

public long getLastMillisecond (TimeZone zone)

This method is deprecated.
As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getLastMillisecond(Calendar) instead.

Returns the last millisecond of the time period, evaluated within a specific time zone.

Parameters
zone the time zone (null not permitted).
Returns
  • The last millisecond of the time period.
See Also

public abstract long getLastMillisecond (Calendar calendar)

Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).

Parameters
calendar the calendar (null not permitted).
Returns
  • The last millisecond of the time period.
See Also

public abstract long 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 the peg(Calendar) method.

Returns
  • The last millisecond of the time period.
See Also

public long getMiddleMillisecond (Calendar calendar)

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.

public long getMiddleMillisecond ()

Returns the millisecond closest to the middle of the time period.

Returns
  • The middle millisecond.

public long getMiddleMillisecond (TimeZone zone)

This method is deprecated.
As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call getMiddleMillisecond(Calendar) instead.

Returns the millisecond closest to the middle of the time period, evaluated within a specific time zone.

Parameters
zone the time zone (null not permitted).
Returns
  • The middle millisecond.

public abstract long getSerialIndex ()

Returns a serial index number for the time unit.

Returns
  • The serial index number.

public Date getStart ()

Returns the date/time that marks the start of the time period. This method returns a new Date instance every time it is called.

Returns
  • The start date/time.
See Also

public abstract RegularTimePeriod next ()

Returns the time period following this one, or null if some limit has been reached.

Returns
  • The next time period (possibly null).

public abstract void peg (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).

Parameters
calendar the calendar (null not permitted).

public abstract RegularTimePeriod previous ()

Returns the time period preceding this one, or null if some lower limit has been reached.

Returns
  • The previous time period (possibly null).

public String toString ()

Returns a string representation of the time period.

Returns
  • The string.