org.jfree.data.time

Class SimpleTimePeriod

public class SimpleTimePeriod extends Object implements TimePeriod, Comparable, Serializable

An arbitrary period of time, measured to millisecond precision using java.util.Date.

This class is intentionally immutable (that is, once constructed, you cannot alter the start and end attributes).

Constructor Summary
SimpleTimePeriod(long start, long end)
Creates a new time allocation.
SimpleTimePeriod(Date start, Date end)
Creates a new time allocation.
Method Summary
intcompareTo(Object obj)
Returns an integer that indicates the relative ordering of two time periods.
booleanequals(Object obj)
Tests this time period instance for equality with an arbitrary object.
DategetEnd()
Returns the end date/time.
longgetEndMillis()
Returns the end date/time in milliseconds.
DategetStart()
Returns the start date/time.
longgetStartMillis()
Returns the start date/time in milliseconds.
inthashCode()
Returns a hash code for this object instance.

Constructor Detail

SimpleTimePeriod

public SimpleTimePeriod(long start, long end)
Creates a new time allocation.

Parameters: start the start date/time in milliseconds. end the end date/time in milliseconds.

SimpleTimePeriod

public SimpleTimePeriod(Date start, Date end)
Creates a new time allocation.

Parameters: start the start date/time (null not permitted). end the end date/time (null not permitted).

Method Detail

compareTo

public int compareTo(Object obj)
Returns an integer that indicates the relative ordering of two time periods.

Parameters: obj the object (null not permitted).

Returns: An integer.

Throws: ClassCastException if obj is not an instance of TimePeriod.

equals

public boolean equals(Object obj)
Tests this time period instance for equality with an arbitrary object. The object is considered equal if it is an instance of TimePeriod and it has the same start and end dates.

Parameters: obj the other object (null permitted).

Returns: A boolean.

getEnd

public Date getEnd()
Returns the end date/time.

Returns: The end date/time (never null).

getEndMillis

public long getEndMillis()
Returns the end date/time in milliseconds.

Returns: The end.

Since: 1.0.10.

getStart

public Date getStart()
Returns the start date/time.

Returns: The start date/time (never null).

getStartMillis

public long getStartMillis()
Returns the start date/time in milliseconds.

Returns: The start.

Since: 1.0.10.

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 - see:

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

Returns: A hash code.

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