com.jrefinery.data
Class FixedMillisecond

java.lang.Object
  |
  +--com.jrefinery.data.TimePeriod
        |
        +--com.jrefinery.data.FixedMillisecond
All Implemented Interfaces:
java.lang.Comparable, com.jrefinery.date.MonthConstants

public class FixedMillisecond
extends TimePeriod

Wrapper for a java.util.Date object that allows it to be used as a TimePeriod.

This class is immutable, which is a requirement for all TimePeriod subclasses.

Author:
DG

Fields inherited from class com.jrefinery.data.TimePeriod
DEFAULT_TIME_ZONE, WORKING_CALENDAR
 
Fields inherited from interface com.jrefinery.date.MonthConstants
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
 
Constructor Summary
FixedMillisecond()
          Constructs a millisecond based on the current system time.
FixedMillisecond(java.util.Date time)
          Constructs a millisecond.
FixedMillisecond(long millisecond)
          Constructs a millisecond.
 
Method Summary
 int compareTo(java.lang.Object o1)
          Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
 long getEnd()
          Returns the last millisecond of the time period.
 long getEnd(java.util.Calendar calendar)
          Returns the last millisecond of the time period.
 long getMiddle()
          Returns the millisecond closest to the middle of the time period.
 long getMiddle(java.util.Calendar calendar)
          Returns the millisecond closest to the middle of the time period.
 long getSerialIndex()
          Returns a serial index number for the millisecond.
 long getStart()
          Returns the first millisecond of the time period.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the time period.
 java.util.Date getTime()
          Returns the date/time.
 TimePeriod next()
          Returns the millisecond following this one.
 TimePeriod previous()
          Returns the millisecond preceding this one.
 
Methods inherited from class com.jrefinery.data.TimePeriod
getEnd, getMiddle, getStart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FixedMillisecond

public FixedMillisecond()
Constructs a millisecond based on the current system time.

FixedMillisecond

public FixedMillisecond(long millisecond)
Constructs a millisecond.
Parameters:
millisecond - the millisecond (same encoding as java.util.Date).

FixedMillisecond

public FixedMillisecond(java.util.Date time)
Constructs a millisecond.
Parameters:
time - the time.
Method Detail

getTime

public java.util.Date getTime()
Returns the date/time.
Returns:
the date/time.

previous

public TimePeriod previous()
Returns the millisecond preceding this one.
Overrides:
previous in class TimePeriod
Returns:
the millisecond preceding this one.

next

public TimePeriod next()
Returns the millisecond following this one.
Overrides:
next in class TimePeriod
Returns:
the millisecond following this one.

compareTo

public int compareTo(java.lang.Object o1)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
Parameters:
o1 - the object to compare.
Returns:
negative == before, zero == same, positive == after.

getStart

public long getStart()
Returns the first millisecond of the time period.
Overrides:
getStart in class TimePeriod
Returns:
the first millisecond of the time period.

getStart

public long getStart(java.util.Calendar calendar)
Returns the first millisecond of the time period.
Overrides:
getStart in class TimePeriod
Parameters:
calendar - the calendar.
Returns:
the first millisecond of the time period.

getEnd

public long getEnd()
Returns the last millisecond of the time period.
Overrides:
getEnd in class TimePeriod
Returns:
the last millisecond of the time period.

getEnd

public long getEnd(java.util.Calendar calendar)
Returns the last millisecond of the time period.
Overrides:
getEnd in class TimePeriod
Parameters:
calendar - the calendar.
Returns:
the last millisecond of the time period.

getMiddle

public long getMiddle()
Returns the millisecond closest to the middle of the time period.
Overrides:
getMiddle in class TimePeriod
Returns:
the millisecond closest to the middle of the time period.

getMiddle

public long getMiddle(java.util.Calendar calendar)
Returns the millisecond closest to the middle of the time period.
Overrides:
getMiddle in class TimePeriod
Parameters:
calendar - the calendar.
Returns:
the millisecond closest to the middle of the time period.

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the millisecond.
Overrides:
getSerialIndex in class TimePeriod
Returns:
The serial index number.