| java.lang.Object
 org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Year
| Constructor Summary | |
| public | Year()
Creates a new Year, based on the current system date/time. | | public | Year(int year)
Creates a time period representing a single year. | | public | Year(Date time)
Creates a new Year, based on a particular instant in time,
using the default time zone. | | public | Year(Date time, TimeZone zone)
Constructs a year, based on a particular instant in time and a time zone. |
| Method Summary | |
| 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.
Parameters:
o1 - the object to compare. | | public boolean | equals(Object object)
Tests the equality of this Year object to an arbitrary
object. | | public long | getFirstMillisecond()
Returns the first millisecond of the year. | | public long | getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - the calendar (null not permitted). | | public long | getLastMillisecond()
Returns the last millisecond of the year. | | public long | getLastMillisecond(Calendar calendar)
Returns the last millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - the calendar (null not permitted). | | public long | getSerialIndex()
Returns a serial index number for the year.
The implementation simply returns the year number (e.g. | | public int | getYear()
Returns the year. | | public int | hashCode()
Returns a hash code for this object instance. | | public RegularTimePeriod | next()
Returns the year following this one. | | public static Year | parseYear(String s)
Parses the string argument as a year.
The string format is YYYY.
Parameters:
s - a string representing the year. | | 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). | | public RegularTimePeriod | previous()
Returns the year preceding this one. | | public String | toString()
Returns a string representing the year.. |
| Year | | public Year()(Code) | | Creates a new Year, based on the current system date/time.
|
| Year | | public Year(int year)(Code) | | Creates a time period representing a single year.
Parameters:
year - the year. |
| Year | | public Year(Date time)(Code) | | Creates a new Year, based on a particular instant in time,
using the default time zone.
Parameters:
time - the time (null not permitted). |
| Year | | public Year(Date time, TimeZone zone)(Code) | | Constructs a year, based on a particular instant in time and a time zone.
Parameters:
time - the time.
Parameters:
zone - the time zone. |
| compareTo | | public int compareTo(Object o1)(Code) | | Returns an integer indicating the order of this Year object
relative to the specified object:
negative == before, zero == same, positive == after.
Parameters:
o1 - the object to compare. negative == before, zero == same, positive == after. |
| equals | | public boolean equals(Object object)(Code) | | 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.
Parameters:
object - the object (null permitted). true if the year of this and the object are the same. |
| getFirstMillisecond | | public long getFirstMillisecond()(Code) | | 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
Year.peg(Calendar) method.
The first millisecond of the year.
See Also: Year.getLastMillisecond() |
| getFirstMillisecond | | public long getFirstMillisecond(Calendar calendar)(Code) | | Returns the first millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - the calendar (null not permitted). The first millisecond of the year.
throws:
NullPointerException - if calendar is null. |
| getLastMillisecond | | public long getLastMillisecond()(Code) | | 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
Year.peg(Calendar) method.
The last millisecond of the year.
See Also: Year.getFirstMillisecond() |
| getLastMillisecond | | public long getLastMillisecond(Calendar calendar)(Code) | | Returns the last millisecond of the year, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - the calendar (null not permitted). The last millisecond of the year.
throws:
NullPointerException - if calendar is null. |
| getSerialIndex | | public long getSerialIndex()(Code) | | Returns a serial index number for the year.
The implementation simply returns the year number (e.g. 2002).
The serial index number. |
| getYear | | public int getYear()(Code) | | Returns the year.
The year. |
| hashCode | | public int hashCode()(Code) | | 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
A hash code. |
| next | | public RegularTimePeriod next()(Code) | | Returns the year following this one.
The year following this one (or null if the currentyear is 9999). |
| parseYear | | public static Year parseYear(String s)(Code) | | Parses the string argument as a year.
The string format is YYYY.
Parameters:
s - a string representing the year. null if the string is not parseable, the year otherwise. |
| peg | | public void peg(Calendar calendar)(Code) | | Recalculates the start date/time and end date/time for this time period
relative to the supplied calendar (which incorporates a time zone).
Parameters:
calendar - the calendar (null not permitted).
since:
1.0.3 |
| previous | | public RegularTimePeriod previous()(Code) | | Returns the year preceding this one.
The year preceding this one (or null if the current year is 1900). |
| toString | | public String toString()(Code) | | Returns a string representing the year..
A string representing the year. |
|
|