org.jfree.data.time
Class Year
- Comparable, MonthConstants, Serializable, TimePeriod
Represents a year in the range 1900 to 9999. This class is immutable, which
is a requirement for all
RegularTimePeriod subclasses.
Year()- Creates a new
Year, based on the current system date/time.
|
Year(Date time)- Creates a new
Year, based on a particular instant in time,
using the default time zone.
|
Year(Date time, TimeZone zone)- Constructs a year, based on a particular instant in time and a time zone.
|
Year(int year)- Creates a time period representing a single year.
|
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.
|
boolean | equals(Object object)- Tests the equality of this
Year object to an arbitrary
object.
|
long | getFirstMillisecond()- Returns the first millisecond of the year.
|
long | getFirstMillisecond(Calendar calendar)- Returns the first millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
|
long | getLastMillisecond()- Returns the last millisecond of the year.
|
long | getLastMillisecond(Calendar calendar)- Returns the last millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
|
long | getSerialIndex()- Returns a serial index number for the year.
|
int | getYear()- Returns the year.
|
int | hashCode()- Returns a hash code for this object instance.
|
RegularTimePeriod | next()- Returns the year following this one.
|
static Year | parseYear(String s)- Parses the string argument as a year.
|
void | peg(Calendar calendar)- Recalculates the start date/time and end date/time for this time period
relative to the supplied calendar (which incorporates a time zone).
|
RegularTimePeriod | previous()- Returns the year preceding this one.
|
String | toString()- Returns a string representing the year..
|
createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getSerialIndex, getStart, next, peg, previous, toString |
Year
public Year()
Creates a new Year, based on the current system date/time.
Year
public Year(Date time)
Creates a new Year, based on a particular instant in time,
using the default time zone.
time - the time (null not permitted).
Year
public Year(Date time,
TimeZone zone) Constructs a year, based on a particular instant in time and a time zone.
time - the time.zone - the time zone.
Year
public Year(int year)
Creates a time period representing a single year.
compareTo
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.
- negative == before, zero == same, positive == after.
equals
public boolean equals(Object 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.
object - the object (null permitted).
true if the year of this and the object are the
same.
getFirstMillisecond
public long getFirstMillisecond()
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
peg(Calendar) method.
- getFirstMillisecond in interface RegularTimePeriod
- The first millisecond of the year.
getFirstMillisecond
public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
- getFirstMillisecond in interface RegularTimePeriod
calendar - the calendar (null not permitted).
- The first millisecond of the year.
getLastMillisecond
public long getLastMillisecond()
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
peg(Calendar) method.
- getLastMillisecond in interface RegularTimePeriod
- The last millisecond of the year.
getLastMillisecond
public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
- getLastMillisecond in interface RegularTimePeriod
calendar - the calendar (null not permitted).
- The last millisecond of the year.
getYear
public int getYear()
Returns the year.
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:
http://developer.java.sun.com/developer/Books/effectivejava
/Chapter3.pdf
parseYear
public static Year parseYear(String s)
Parses the string argument as a year.
The string format is YYYY.
s - a string representing the year.
null if the string is not parseable, the year
otherwise.
peg
public void peg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period
relative to the supplied calendar (which incorporates a time zone).
- peg in interface RegularTimePeriod
calendar - the calendar (null not permitted).