net.simplace.util.jfreechart.TimePeriod
public class TimePeriod extends org.jfree.data.time.RegularTimePeriod
implements java.io.Serializable {
// Public Constructors
public TimePeriod();
public TimePeriod(Date start, Date end);
// Public Instance Methods public long
getFirstMillisecond();
// Defines
org.jfree.data.time.RegularTimePeriod
Returns the first millisecond of the year. This will be determined
relative to the time zone specified in the constructor, or in the
calendar instance passed in the most recent call to the
net.simplace.util.jfreechart.TimePeriod.peg(Calendar) method.
returns The first millisecond of the year.
public long
getLastMillisecond();
// Defines
org.jfree.data.time.RegularTimePeriod
Returns the last millisecond of the year. This will be
determined relative to the time zone specified in the constructor, or
in the calendar instance passed in the most recent call to the
net.simplace.util.jfreechart.TimePeriod.peg(Calendar) method.
returns The last millisecond of the year.
public void
peg(Calendar calendar);
// Defines
org.jfree.data.time.RegularTimePeriod
Recalculates the start date/time and end date/time for this time period
relative to the supplied calendar (which incorporates a time zone).
- calendar the calendar (
null
not permitted).
public long
getSerialIndex();
// Defines
org.jfree.data.time.RegularTimePeriod
Returns a serial index number for the year.
The implementation simply returns the second of the start time number (e.g. 2002).
returns The serial index number.
public long
getFirstMillisecond(Calendar calendar);
// Defines org.jfree.data.time.RegularTimePeriod
Returns the first millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
- calendar the calendar (
null
not permitted).
returns The first millisecond of the year.
public long
getLastMillisecond(Calendar calendar);
// Defines org.jfree.data.time.RegularTimePeriod
Returns the last millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
- calendar the calendar (
null
not permitted).
returns The last millisecond of the year.
public boolean
equals(Object obj);
// Overrides java.lang.Object
Tests the equality of this
Year
object to an arbitrary
object. Returns
true
if the target is a
Year
instance representing the same year as this object. In all other cases,
returns
false
.
- obj the object (
null
permitted).
returns true
if the year of this and the object are the
same.
public int
hashCode();
// Overrides java.lang.Object
Returns a hash code for this object instance. The approach described by
Joshua Bloch in "Effective Java" has been used here:
http://developer.java.sun.com/developer/Books/effectivejava
/Chapter3.pdf
returns A hash code.
public int
compareTo(Object o1);
Returns an integer indicating the order of this
Year
object
relative to the specified object:
negative == before, zero == same, positive == after.
- o1 the object to compare.
returns negative == before, zero == same, positive == after.
public String toString(); // Defines org.jfree.data.time.RegularTimePeriod
Returns a string representing the year..
returns A string representing the year.
public RegularTimePeriod previous(); // Defines
org.jfree.data.time.RegularTimePeriod
public RegularTimePeriod next(); // Defines
org.jfree.data.time.RegularTimePeriod
}
Hierarchy: java.lang.Object - org.jfree.data.time.RegularTimePeriod (org.jfree.data.time.TimePeriod, java.lang.Comparable, org.jfree.date.MonthConstants) - TimePeriod (java.io.Serializable)