|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.jrefinery.data.TimePeriod | +--com.jrefinery.data.Year
Represents a year in the range 1900 to 9999.
This class is immutable, which is a requirement for all TimePeriod subclasses.
Fields inherited from class com.jrefinery.data.TimePeriod |
DEFAULT_TIME_ZONE, WORKING_CALENDAR |
Fields inherited from interface com.jrefinery.date.MonthConstants |
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
Constructor Summary | |
Year()
Constructs a new Year, based on the current system date/time. |
|
Year(java.util.Date time)
Constructs 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)
Constructs 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 |
getEnd(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. |
long |
getStart(java.util.Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied calendar (which determines the time zone). |
int |
getYear()
Returns the year. |
TimePeriod |
next()
Returns the year following this one. |
static Year |
parseYear(java.lang.String s)
Parses the string argument as a year. |
TimePeriod |
previous()
Returns the year preceding this one. |
java.lang.String |
toString()
Returns a string representing the year (e.g. |
Methods inherited from class com.jrefinery.data.TimePeriod |
getEnd, getEnd, getMiddle, getMiddle, getMiddle, getStart, getStart |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Year()
public Year(int year)
year
- the year.public Year(java.util.Date time)
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 TimePeriod previous()
previous
in class TimePeriod
public TimePeriod next()
next
in class TimePeriod
public long getSerialIndex()
The implementation simply returns the year number (e.g. 2002).
getSerialIndex
in class TimePeriod
public long getStart(java.util.Calendar calendar)
getStart
in class TimePeriod
calendar
- the calendar.public long getEnd(java.util.Calendar calendar)
getEnd
in class TimePeriod
calendar
- the calendar.public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
object
- the object.true
if the year of this and the object are the same.public int compareTo(java.lang.Object o1)
o1
- the object to compare.public java.lang.String toString()
toString
in class java.lang.Object
public static Year parseYear(java.lang.String s) throws TimePeriodFormatException
The string format is YYYY.
s
- a string representing the year.null
if the string is not parseable, the year otherwise.TimePeriodFormatException
- if there is a parsing error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |