org.jfree.data.time

Class FixedMillisecond

Implemented Interfaces:
Comparable, MonthConstants, Serializable, TimePeriod

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.

Field Summary

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

DEFAULT_TIME_ZONE, WORKING_CALENDAR

Constructor Summary

FixedMillisecond()
Constructs a millisecond based on the current system time.
FixedMillisecond(Date time)
Constructs a millisecond.
FixedMillisecond(long millisecond)
Constructs a millisecond.

Method Summary

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.
boolean
equals(Object object)
Tests the equality of this object against an arbitrary Object.
long
getFirstMillisecond()
Returns the first millisecond of the time period.
long
getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
long
getLastMillisecond()
Returns the last millisecond of the time period.
long
getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
long
getMiddleMillisecond()
Returns the millisecond closest to the middle of the time period.
long
getMiddleMillisecond(Calendar calendar)
Returns the millisecond closest to the middle of the time period.
long
getSerialIndex()
Returns a serial index number for the millisecond.
Date
getTime()
Returns the date/time.
int
hashCode()
Returns a hash code for this object instance.
RegularTimePeriod
next()
Returns the millisecond following this one.
void
peg(Calendar calendar)
This method is overridden to do nothing.
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

Constructor Details

FixedMillisecond

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

FixedMillisecond

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

FixedMillisecond

public FixedMillisecond(long millisecond)
Constructs a millisecond.
Parameters:
millisecond - the millisecond (same encoding as java.util.Date).

Method Details

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.
Overrides:
getFirstMillisecond in interface RegularTimePeriod
Returns:
The first millisecond of the time period.

getFirstMillisecond

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

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the time period.
Overrides:
getLastMillisecond in interface RegularTimePeriod
Returns:
The last millisecond of the time period.

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
Overrides:
getLastMillisecond in interface RegularTimePeriod
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.
Overrides:
getMiddleMillisecond in interface RegularTimePeriod
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.
Overrides:
getMiddleMillisecond in interface RegularTimePeriod
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.
Overrides:
getSerialIndex in interface RegularTimePeriod
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.
Overrides:
next in interface RegularTimePeriod
Returns:
The millisecond following this one.

peg

public void peg(Calendar calendar)
This method is overridden to do nothing.
Overrides:
peg in interface RegularTimePeriod
Parameters:
calendar - ignored
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.