Module org.jfree.chart

Package org.jfree.data.time

Class FixedMillisecond

java.lang.Object

org.jfree.data.time.RegularTimePeriod

org.jfree.data.time.FixedMillisecond

All Implemented Interfaces:

Serializable, Comparable, MonthConstants, 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.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jfree.chart.date.MonthConstants

APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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 (creates a new Date instance each time this method is called).
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, getCalendarInstance, getEnd, getMillisecond, getStart, setCalendarInstancePrototype, setThreadLocalCalendarInstance, toString

Methods inherited from class java.lang.Object

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

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 (null not permitted).

Method Detail

getTime

public Date getTime()

Returns the date/time (creates a new Date instance each time this method is called).

Returns:

The date/time.

peg

public void peg(Calendar calendar)

This method is overridden to do nothing.

Specified by:

peg in class RegularTimePeriod

Parameters:

calendar - ignored

Since:

1.0.3

previous

public RegularTimePeriod previous()

Returns the millisecond preceding this one.

Specified by:

previous in class RegularTimePeriod

Returns:

The millisecond preceding this one.

next

public RegularTimePeriod next()

Returns the millisecond following this one.

Specified by:

next in class RegularTimePeriod

Returns:

The millisecond following this one.

equals

public boolean equals(Object object)

Tests the equality of this object against an arbitrary Object.

Overrides:

equals in class Object

Parameters:

object - the object to compare

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this object instance.

Overrides:

hashCode in class Object

Returns:

A hash code.

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.

Specified by:

compareTo in interface Comparable

Parameters:

o1 - the object to compare.

Returns:

negative == before, zero == same, positive == after.

getFirstMillisecond

public long getFirstMillisecond()

Returns the first millisecond of the time period.

Specified by:

getFirstMillisecond in class RegularTimePeriod

Returns:

The first millisecond of the time period.

See Also:

RegularTimePeriod.getLastMillisecond()

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)

Returns the first millisecond of the time period.

Specified by:

getFirstMillisecond in class RegularTimePeriod

Parameters:

calendar - the calendar.

Returns:

The first millisecond of the time period.

See Also:

RegularTimePeriod.getLastMillisecond(Calendar)

getLastMillisecond

public long getLastMillisecond()

Returns the last millisecond of the time period.

Specified by:

getLastMillisecond in class RegularTimePeriod

Returns:

The last millisecond of the time period.

See Also:

RegularTimePeriod.getFirstMillisecond()

getLastMillisecond

public long getLastMillisecond(Calendar calendar)

Returns the last millisecond of the time period.

Specified by:

getLastMillisecond in class RegularTimePeriod

Parameters:

calendar - the calendar.

Returns:

The last millisecond of the time period.

See Also:

RegularTimePeriod.getFirstMillisecond(Calendar)

getMiddleMillisecond

public long getMiddleMillisecond()

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

Overrides:

getMiddleMillisecond in class 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 class 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.

Specified by:

getSerialIndex in class RegularTimePeriod

Returns:

The serial index number.