com.jrefinery.data
Class Millisecond

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

All Implemented Interfaces:

MonthConstants, java.lang.Comparable

public class Millisecond
extends TimePeriod

Represents a millisecond.

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

Field Summary

static int	FIRST_MILLISECOND_IN_SECOND
static int	LAST_MILLISECOND_IN_SECOND
protected int	millisecond The millisecond.
protected Second	second

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

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

Millisecond(java.util.Date time)
Constructs a millisecond.

Millisecond(java.util.Date time, java.util.TimeZone zone)

Millisecond(int millisecond, Second second)
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.
boolean	equals(java.lang.Object object) Tests the equality of this object against an arbitrary Object.
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	getMillisecond() Returns the millisecond.
Second	getSecond()
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).
static void	main(java.lang.String[] args) Test code - please ignore.
TimePeriod	next() Returns the millisecond following this one.
TimePeriod	previous() Returns the millisecond preceding this one.
java.lang.String	toString()

Methods inherited from class com.jrefinery.data.TimePeriod

getEnd, getMiddle, getMiddle, getMiddle, getStart

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FIRST_MILLISECOND_IN_SECOND

public static final int FIRST_MILLISECOND_IN_SECOND

See Also:

Constant Field Values

LAST_MILLISECOND_IN_SECOND

public static final int LAST_MILLISECOND_IN_SECOND

See Also:

Constant Field Values

millisecond

protected int millisecond

The millisecond.

second

protected Second second

Constructor Detail

Millisecond

public Millisecond()

Constructs a millisecond based on the current system time.

Millisecond

public Millisecond(int millisecond,
                   Second second)

Constructs a millisecond.

Parameters:

millisecond - The millisecond (same encoding as java.util.Date).

Millisecond

public Millisecond(java.util.Date time)

Constructs a millisecond.

Parameters:

time - The time.

Millisecond

public Millisecond(java.util.Date time,
                   java.util.TimeZone zone)

Method Detail

getSecond

public Second getSecond()

getMillisecond

public long getMillisecond()

Returns the millisecond.

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.

equals

public boolean equals(java.lang.Object object)

Tests the equality of this object against an arbitrary Object.

This method will return true ONLY if the object is a Millisecond object representing the same millisecond as this instance.

Overrides:

equals in class java.lang.Object

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

main

public static void main(java.lang.String[] args)

Test code - please ignore.