|
||||||||||
| 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.Day
public class Day
Represents a single day in the range 1-Jan-1900 to 31-Dec-9999. This class
is immutable, which is a requirement for all RegularTimePeriod
subclasses.
| Field Summary | |
|---|---|
protected static java.text.DateFormat |
DATE_FORMAT
A standard date formatter. |
protected static java.text.DateFormat |
DATE_FORMAT_LONG
A date formatter for the default locale. |
protected static java.text.DateFormat |
DATE_FORMAT_MEDIUM
A date formatter for the default locale. |
protected static java.text.DateFormat |
DATE_FORMAT_SHORT
A date formatter for the default locale. |
| 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 | |
|---|---|
Day()
Creates a new instance, derived from the system date/time (and assuming the default timezone). |
|
Day(java.util.Date time)
Constructs a new instance, based on a particular date/time and the default time zone. |
|
Day(java.util.Date time,
java.util.TimeZone zone)
Constructs a new instance, based on a particular date/time and time zone. |
|
Day(int day,
int month,
int year)
Constructs a new one day time period. |
|
Day(org.jfree.date.SerialDate serialDate)
Constructs a new one day time period. |
|
| Method Summary | |
|---|---|
int |
compareTo(java.lang.Object o1)
Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after. |
boolean |
equals(java.lang.Object obj)
Tests the equality of this Day object to an arbitrary object. |
int |
getDayOfMonth()
Returns the day of the month. |
long |
getFirstMillisecond()
Returns the first millisecond of the day. |
long |
getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone). |
long |
getLastMillisecond()
Returns the last millisecond of the day. |
long |
getLastMillisecond(java.util.Calendar calendar)
Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone). |
int |
getMonth()
Returns the month. |
org.jfree.date.SerialDate |
getSerialDate()
Returns the day as a SerialDate. |
long |
getSerialIndex()
Returns a serial index number for the day. |
int |
getYear()
Returns the year. |
int |
hashCode()
Returns a hash code for this object instance. |
RegularTimePeriod |
next()
Returns the day following this one, or null if some limit
has been reached. |
static Day |
parseDay(java.lang.String s)
Parses the string argument as a day. |
void |
peg(java.util.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 day preceding this one. |
java.lang.String |
toString()
Returns a string representing the day. |
| Methods inherited from class org.jfree.data.time.RegularTimePeriod |
|---|
createInstance, downsize, getEnd, getFirstMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getStart |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static final java.text.DateFormat DATE_FORMAT
protected static final java.text.DateFormat DATE_FORMAT_SHORT
protected static final java.text.DateFormat DATE_FORMAT_MEDIUM
protected static final java.text.DateFormat DATE_FORMAT_LONG
| Constructor Detail |
|---|
public Day()
public Day(int day,
int month,
int year)
day - the day-of-the-month.month - the month (1 to 12).year - the year (1900 <= year <= 9999).public Day(org.jfree.date.SerialDate serialDate)
serialDate - the day (null not permitted).public Day(java.util.Date time)
time - the time (null not permitted).
public Day(java.util.Date time,
java.util.TimeZone zone)
time - the date/time.zone - the time zone.| Method Detail |
|---|
public org.jfree.date.SerialDate getSerialDate()
SerialDate. Note: the reference that is
returned should be an instance of an immutable SerialDate
(otherwise the caller could use the reference to alter the state of
this Day instance, and Day is supposed
to be immutable).
SerialDate.public int getYear()
public int getMonth()
public int getDayOfMonth()
public long getFirstMillisecond()
peg(Calendar) method.
getFirstMillisecond in class RegularTimePeriodgetLastMillisecond()public long getLastMillisecond()
peg(Calendar) method.
getLastMillisecond in class RegularTimePeriodgetFirstMillisecond()public void peg(java.util.Calendar calendar)
peg in class RegularTimePeriodcalendar - the calendar (null not permitted).public RegularTimePeriod previous()
previous in class RegularTimePeriodpublic RegularTimePeriod next()
null if some limit
has been reached.
next in class RegularTimePeriodnull if some limit
has been reached.public long getSerialIndex()
getSerialIndex in class RegularTimePeriodpublic long getFirstMillisecond(java.util.Calendar calendar)
getFirstMillisecond in class RegularTimePeriodcalendar - calendar to use (null not permitted).
java.lang.NullPointerException - if calendar is
null.RegularTimePeriod.getLastMillisecond(Calendar)public long getLastMillisecond(java.util.Calendar calendar)
getLastMillisecond in class RegularTimePeriodcalendar - calendar to use (null not permitted).
java.lang.NullPointerException - if calendar is
null.RegularTimePeriod.getFirstMillisecond(Calendar)public boolean equals(java.lang.Object obj)
equals in class java.lang.Objectobj - the object (null permitted).
public int hashCode()
http://developer.java.sun.com/developer/Books/effectivejava
/Chapter3.pdf
hashCode in class java.lang.Objectpublic int compareTo(java.lang.Object o1)
compareTo in interface java.lang.Comparableo1 - the object to compare.
public java.lang.String toString()
toString in class RegularTimePeriodpublic static Day parseDay(java.lang.String s)
This method is required to recognise YYYY-MM-DD as a valid format. Anything else, for now, is a bonus.
s - the date string to parse.
null if the string does not contain any parseable
string, the day otherwise.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||