public class

SimpleTimePeriod

extends Object
implements Serializable Comparable<T> TimePeriod
java.lang.Object
   ↳ org.jfree.data.time.SimpleTimePeriod

Class Overview

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

Summary

Public Constructors
SimpleTimePeriod(long start, long end)
Creates a new time allocation.
SimpleTimePeriod(Date start, Date end)
Creates a new time allocation.
Public Methods
int compareTo(Object obj)
Returns an integer that indicates the relative ordering of two time periods.
boolean equals(Object obj)
Tests this time period instance for equality with an arbitrary object.
Date getEnd()
Returns the end date/time.
long getEndMillis()
Returns the end date/time in milliseconds.
Date getStart()
Returns the start date/time.
long getStartMillis()
Returns the start date/time in milliseconds.
int hashCode()
Returns a hash code for this object instance.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable
From interface org.jfree.data.time.TimePeriod

Public Constructors

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.

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

Public Methods

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.

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.

public Date getEnd ()

Returns the end date/time.

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

public long getEndMillis ()

Returns the end date/time in milliseconds.

Returns
  • The end.

public Date getStart ()

Returns the start date/time.

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

public long getStartMillis ()

Returns the start date/time in milliseconds.

Returns
  • The start.

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.