com.jrefinery.data
Class FixedMillisecond

java.lang.Object
  com.jrefinery.data.TimePeriod
      com.jrefinery.data.FixedMillisecond

All Implemented Interfaces:

MonthConstants, java.lang.Comparable

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.

Field Summary

protected java.util.Date

time The millisecond.

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, evaluated using the supplied calendar (which incorporates a timezone).
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, evaluated using the supplied calendar (which incorporates a timezone).
long	getStart() Returns the first millisecond of the time period.
long	getStart(java.util.Calendar calendar) Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
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

Field Detail

time

protected java.util.Date time

The millisecond.

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.

previous

public TimePeriod previous()

Returns the millisecond preceding this one.

Specified by:

previous in class TimePeriod

Returns:

The previous time period.

next

public TimePeriod next()

Returns the millisecond following this one.

Specified by:

next in class TimePeriod

Returns:

The next time period.

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.

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)

Description copied from class: TimePeriod

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

Specified by:

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)

Description copied from class: TimePeriod

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

Specified by:

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)

Description copied from class: TimePeriod

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

Overrides:

getMiddle in class TimePeriod

Parameters:

calendar - The calendare.

Returns:

The millisecond closest to the middle of the time period.