Save This Page
Home » jcommon-1.0.13 » org.jfree » data » time » [javadoc | source]
org.jfree.data.time
abstract public class: RegularTimePeriod [javadoc | source]
java.lang.Object
   org.jfree.data.time.RegularTimePeriod

All Implemented Interfaces:
    TimePeriod, MonthConstants, Comparable

Direct Known Subclasses:
    FixedMillisecond, Day, Minute, Second, Year, Millisecond, Hour, Quarter, Week, Month

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
public static final  TimeZone DEFAULT_TIME_ZONE    The default time zone. 
public static final  Calendar WORKING_CALENDAR    A working calendar (recycle to avoid unnecessary object creation).
     
    Method from org.jfree.data.time.RegularTimePeriod Summary:
    createInstance,   downsize,   getEnd,   getFirstMillisecond,   getFirstMillisecond,   getFirstMillisecond,   getLastMillisecond,   getLastMillisecond,   getLastMillisecond,   getMiddleMillisecond,   getMiddleMillisecond,   getMiddleMillisecond,   getSerialIndex,   getStart,   next,   peg,   previous,   toString
    Methods from java.lang.Object:
    equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
    Method from org.jfree.data.time.RegularTimePeriod Detail:
     public static RegularTimePeriod createInstance(Class c,
        Date millisecond,
        TimeZone zone) 
      Creates a time period that includes the specified millisecond, assuming the given time zone.
     public static Class downsize(Class c) 
     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.
     abstract public 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.
     public long getFirstMillisecond(TimeZone zone) 
    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.
     abstract public long getFirstMillisecond(Calendar calendar)
      Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
     abstract public 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.
     public long getLastMillisecond(TimeZone zone) 
    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.
     abstract public long getLastMillisecond(Calendar calendar)
      Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
     public long getMiddleMillisecond() 
      Returns the millisecond closest to the middle of the time period.
     public long getMiddleMillisecond(TimeZone zone) 
    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.
     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).
     abstract public long getSerialIndex()
      Returns a serial index number for the time unit.
     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.
     abstract public RegularTimePeriod next()
      Returns the time period following this one, or null if some limit has been reached.
     abstract public  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 public RegularTimePeriod previous()
      Returns the time period preceding this one, or null if some lower limit has been reached.
     public String toString() 
      Returns a string representation of the time period.