|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Year
Represents a year in the range 1900 to 9999.
This class is immutable, which is a requirement for all RegularTimePeriod subclasses.
| Field Summary |
| Fields inherited from class org.jfree.data.time.RegularTimePeriod |
DEFAULT_TIME_ZONE, WORKING_CALENDAR |
| Fields inherited from interface org.jfree.date.MonthConstants |
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
| Constructor Summary | |
Year()
Creates a new Year, based on the current system date/time. |
|
Year(java.util.Date time)
Creates a new Year, based on a particular instant in time, using the
default time zone. |
|
Year(java.util.Date time,
java.util.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. |
|
| Method Summary | |
int |
compareTo(java.lang.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(java.lang.Object object)
Tests the equality of this Year object to an arbitrary object. |
long |
getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied calendar (which determines the time zone). |
long |
getLastMillisecond(java.util.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(java.lang.String s)
Parses the string argument as a year. |
RegularTimePeriod |
previous()
Returns the year preceding this one. |
java.lang.String |
toString()
Returns a string representing the year.. |
| Methods inherited from class org.jfree.data.time.RegularTimePeriod |
getEnd, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getStart |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public Year()
Year, based on the current system date/time.
public Year(int year)
year - the year.public Year(java.util.Date time)
Year, based on a particular instant in time, using the
default time zone.
time - the time.
public Year(java.util.Date time,
java.util.TimeZone zone)
time - the time.zone - the time zone.| Method Detail |
public int getYear()
public RegularTimePeriod previous()
previous in class RegularTimePeriodpublic RegularTimePeriod next()
next in class RegularTimePeriodpublic long getSerialIndex()
The implementation simply returns the year number (e.g. 2002).
getSerialIndex in class RegularTimePeriodpublic long getFirstMillisecond(java.util.Calendar calendar)
getFirstMillisecond in class RegularTimePeriodcalendar - the calendar.
public long getLastMillisecond(java.util.Calendar calendar)
getLastMillisecond in class RegularTimePeriodcalendar - the calendar.
public boolean equals(java.lang.Object object)
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.
true if the year of this and the object are the same.public int hashCode()
The approach described by Joshua Bloch in "Effective Java" has been used here:
http://developer.java.sun.com/developer/Books/effectivejava/Chapter3.pdf
public int compareTo(java.lang.Object o1)
Year object relative to
the specified object:
negative == before, zero == same, positive == after.
compareTo in interface java.lang.Comparableo1 - the object to compare.
public java.lang.String toString()
toString in class RegularTimePeriodpublic static Year parseYear(java.lang.String s)
The string format is YYYY.
s - a string representing the year.
null if the string is not parseable, the year otherwise.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||