org.jfree.data.time

Class Millisecond

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 intFIRST_MILLISECOND_IN_SECOND
A constant for the first millisecond in a second.
static intLAST_MILLISECOND_IN_SECOND
A constant for the last millisecond in a second.
Constructor Summary
Millisecond()
Constructs a millisecond based on the current system time.
Millisecond(int millisecond, Second second)
Constructs a millisecond.
Millisecond(int millisecond, int second, int minute, int hour, int day, int month, int year)
Creates a new millisecond.
Millisecond(Date time)
Constructs a new millisecond using the default time zone.
Millisecond(Date time, TimeZone zone)
Creates a millisecond.
Millisecond(Date time, TimeZone zone, Locale locale)
Creates a millisecond.
Method Summary
intcompareTo(Object obj)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object obj)
Tests the equality of this object against an arbitrary Object.
longgetFirstMillisecond()
Returns the first millisecond of the second.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
longgetLastMillisecond()
Returns the last millisecond of the second.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
longgetMillisecond()
Returns the millisecond.
SecondgetSecond()
Returns the second.
longgetSerialIndex()
Returns a serial index number for the millisecond.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the millisecond following this one.
voidpeg(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).
RegularTimePeriodprevious()
Returns the millisecond preceding this one.

Field Detail

FIRST_MILLISECOND_IN_SECOND

public static final int FIRST_MILLISECOND_IN_SECOND
A constant for the first millisecond in a second.

LAST_MILLISECOND_IN_SECOND

public static final int LAST_MILLISECOND_IN_SECOND
A constant for the last millisecond in a 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 (0-999). second the second.

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(Date time)
Constructs a new millisecond using the default time zone.

Parameters: time the time.

See Also: Millisecond

Millisecond

public Millisecond(Date time, TimeZone zone)

Deprecated: As of 1.0.13, use the constructor that specifies the locale also.

Creates a millisecond.

Parameters: time the instant in time. zone the time zone.

Millisecond

public Millisecond(Date time, TimeZone zone, Locale locale)
Creates a millisecond.

Parameters: time the date-time (null not permitted). zone the time zone (null not permitted). locale the locale (null not permitted).

Since: 1.0.13

Method Detail

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 method.

Returns: The first millisecond of the second.

See Also: getLastMillisecond

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.

Parameters: calendar the calendar (null not permitted).

Returns: The first millisecond of the time period.

Throws: NullPointerException if calendar is null.

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 method.

Returns: The last millisecond of the second.

See Also: getFirstMillisecond

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.

Parameters: calendar the calendar (null not permitted).

Returns: The last millisecond of the time period.

Throws: NullPointerException if calendar is null.

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.

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.

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).

Parameters: calendar the calendar (null not permitted).

Since: 1.0.3

previous

public RegularTimePeriod previous()
Returns the millisecond preceding this one.

Returns: The millisecond preceding this one.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.