org.jfree.data.time

Class FixedMillisecond

public class FixedMillisecond extends RegularTimePeriod implements Serializable

Wrapper for a java.util.Date object that allows it to be used as a RegularTimePeriod. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.
Constructor Summary
FixedMillisecond()
Constructs a millisecond based on the current system time.
FixedMillisecond(long millisecond)
Constructs a millisecond.
FixedMillisecond(Date time)
Constructs a millisecond.
Method Summary
intcompareTo(Object o1)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object object)
Tests the equality of this object against an arbitrary Object.
longgetFirstMillisecond()
Returns the first millisecond of the time period.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
longgetLastMillisecond()
Returns the last millisecond of the time period.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
longgetMiddleMillisecond()
Returns the millisecond closest to the middle of the time period.
longgetMiddleMillisecond(Calendar calendar)
Returns the millisecond closest to the middle of the time period.
longgetSerialIndex()
Returns a serial index number for the millisecond.
DategetTime()
Returns the date/time.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the millisecond following this one.
voidpeg(Calendar calendar)
This method is overridden to do nothing.
RegularTimePeriodprevious()
Returns the millisecond preceding this one.

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(Date time)
Constructs a millisecond.

Parameters: time the time.

Method Detail

compareTo

public int compareTo(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.

equals

public boolean equals(Object object)
Tests the equality of this object against an arbitrary Object.

Parameters: object the object to compare

Returns: A boolean.

getFirstMillisecond

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

Returns: The first millisecond of the time period.

getFirstMillisecond

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

Parameters: calendar the calendar.

Returns: The first millisecond of the time period.

getLastMillisecond

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

Returns: The last millisecond of the time period.

getLastMillisecond

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

Parameters: calendar the calendar.

Returns: The last millisecond of the time period.

getMiddleMillisecond

public long getMiddleMillisecond()
Returns the millisecond closest to the middle of the time period.

Returns: The millisecond closest to the middle of the time period.

getMiddleMillisecond

public long getMiddleMillisecond(Calendar calendar)
Returns the millisecond closest to the middle of the time period.

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.

Returns: The serial index number.

getTime

public Date getTime()
Returns the date/time.

Returns: The date/time.

hashCode

public int hashCode()
Returns a hash code for this object instance.

Returns: A hash code.

next

public RegularTimePeriod next()
Returns the millisecond following this one.

Returns: The millisecond following this one.

peg

public void peg(Calendar calendar)
This method is overridden to do nothing.

Parameters: calendar ignored

Since: 1.0.3

previous

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

Returns: The millisecond preceding this one.