org.jfree.data.time

Class Millisecond

Implemented Interfaces:
Comparable, MonthConstants, Serializable, TimePeriod

public class Millisecond
extends RegularTimePeriod
implements Serializable

Represents a millisecond. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Field Summary

static int
FIRST_MILLISECOND_IN_SECOND
A constant for the first millisecond in a second.
static int
LAST_MILLISECOND_IN_SECOND
A constant for the last millisecond in a second.

Fields inherited from class org.jfree.data.time.RegularTimePeriod

DEFAULT_TIME_ZONE, WORKING_CALENDAR

Constructor Summary

Millisecond()
Constructs a millisecond based on the current system time.
Millisecond(Date time)
Constructs a millisecond.
Millisecond(Date time, TimeZone zone)
Creates a millisecond.
Millisecond(int millisecond, int second, int minute, int hour, int day, int month, int year)
Creates a new millisecond.
Millisecond(int millisecond, Second second)
Constructs a millisecond.

Method Summary

int
compareTo(Object obj)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
boolean
equals(Object obj)
Tests the equality of this object against an arbitrary Object.
long
getFirstMillisecond()
Returns the first millisecond of the second.
long
getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
long
getLastMillisecond()
Returns the last millisecond of the second.
long
getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
long
getMillisecond()
Returns the millisecond.
Second
getSecond()
Returns the second.
long
getSerialIndex()
Returns a serial index number for the millisecond.
int
hashCode()
Returns a hash code for this object instance.
RegularTimePeriod
next()
Returns the millisecond following this one.
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).
RegularTimePeriod
previous()
Returns the millisecond preceding this one.

Methods inherited from class org.jfree.data.time.RegularTimePeriod

createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getSerialIndex, getStart, next, peg, previous, toString

Field Details

FIRST_MILLISECOND_IN_SECOND

public static final int FIRST_MILLISECOND_IN_SECOND
A constant for the first millisecond in a second.
Field Value:
0

LAST_MILLISECOND_IN_SECOND

public static final int LAST_MILLISECOND_IN_SECOND
A constant for the last millisecond in a second.
Field Value:
999

Constructor Details

Millisecond

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

Millisecond

public Millisecond(Date time)
Constructs a millisecond.
Parameters:
time - the time.

Millisecond

public Millisecond(Date time,
                   TimeZone zone)
Creates a millisecond.
Parameters:
time - the instant in time.
zone - the time zone.

Millisecond

public Millisecond(int millisecond,
                   int second,
                   int minute,
                   int hour,
                   int day,
                   int month,
                   int year)
Creates a new millisecond.
Parameters:
millisecond - the millisecond (0-999).
second - the second (0-59).
minute - the minute (0-59).
hour - the hour (0-23).
day - the day (1-31).
month - the month (1-12).
year - the year (1900-9999).

Millisecond

public Millisecond(int millisecond,
                   Second second)
Constructs a millisecond.
Parameters:
millisecond - the millisecond (0-999).
second - the second.

Method Details

compareTo

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

equals

public boolean equals(Object obj)
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.

Parameters:
obj - the object to compare
Returns:
true if milliseconds and seconds of this and object are the same.

getFirstMillisecond

public long getFirstMillisecond()
Returns the first millisecond of the second. 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.
Overrides:
getFirstMillisecond in interface RegularTimePeriod
Returns:
The first millisecond of the second.

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
Overrides:
getFirstMillisecond in interface RegularTimePeriod
Parameters:
calendar - the calendar (null not permitted).
Returns:
The first millisecond of the time period.

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the second. 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.
Overrides:
getLastMillisecond in interface RegularTimePeriod
Returns:
The last millisecond of the second.

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
Overrides:
getLastMillisecond in interface RegularTimePeriod
Parameters:
calendar - the calendar (null not permitted).
Returns:
The last millisecond of the time period.

getMillisecond

public long getMillisecond()
Returns the millisecond.
Returns:
The millisecond.

getSecond

public Second getSecond()
Returns the second.
Returns:
The second.

getSerialIndex

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

hashCode

public int hashCode()
Returns a hash code for this object instance. The approach described by Joshua Bloch in "Effective Java" has been used here:

http://developer.java.sun.com/developer/Books/effectivejava /Chapter3.pdf

Returns:
A hashcode.

next

public RegularTimePeriod next()
Returns the millisecond following this one.
Overrides:
next in interface RegularTimePeriod
Returns:
The millisecond following this one.

peg

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).
Overrides:
peg in interface RegularTimePeriod
Parameters:
calendar - the calendar (null not permitted).
Since:
1.0.3

previous

public RegularTimePeriod previous()
Returns the millisecond preceding this one.
Overrides:
previous in interface RegularTimePeriod
Returns:
The millisecond preceding this one.