| java.lang.Object
 org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Day
| Constructor Summary | |
| public | Day()
Creates a new instance, derived from the system date/time (and assuming
the default timezone). | | public | Day(int day, int month, int year)
Constructs a new one day time period. | | public | Day(SerialDate serialDate)
Constructs a new one day time period. | | public | Day(Date time)
Constructs a new instance, based on a particular date/time and the
default time zone. | | public | Day(Date time, TimeZone zone)
Constructs a new instance, based on a particular date/time and time zone. |
| Method Summary | |
| public int | compareTo(Object o1)
Returns an integer indicating the order of this Day object relative to
the specified object:
negative == before, zero == same, positive == after.
Parameters:
o1 - the object to compare. | | public boolean | equals(Object obj)
Tests the equality of this Day object to an arbitrary object. | | public int | getDayOfMonth()
Returns the day of the month. | | public long | getFirstMillisecond()
Returns the first millisecond of the day. | | public long | getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - calendar to use (null not permitted). | | public long | getLastMillisecond()
Returns the last millisecond of the day. | | public long | getLastMillisecond(Calendar calendar)
Returns the last millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - calendar to use (null not permitted). | | public int | getMonth()
Returns the month. | | public SerialDate | getSerialDate()
Returns the day as a
SerialDate . | | public long | getSerialIndex()
Returns a serial index number for the day. | | public int | getYear()
Returns the year. | | public int | hashCode()
Returns a hash code for this object instance. | | public RegularTimePeriod | next()
Returns the day following this one, or null if some limit
has been reached. | | public static Day | parseDay(String s)
Parses the string argument as a day.
This method is required to recognise YYYY-MM-DD as a valid format.
Anything else, for now, is a bonus.
Parameters:
s - the date string to parse. | | 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 day preceding this one. | | public String | toString()
Returns a string representing the day. |
| DATE_FORMAT | | final protected static DateFormat DATE_FORMAT(Code) | | A standard date formatter.
|
| DATE_FORMAT_LONG | | final protected static DateFormat DATE_FORMAT_LONG(Code) | | A date formatter for the default locale.
|
| DATE_FORMAT_MEDIUM | | final protected static DateFormat DATE_FORMAT_MEDIUM(Code) | | A date formatter for the default locale.
|
| DATE_FORMAT_SHORT | | final protected static DateFormat DATE_FORMAT_SHORT(Code) | | A date formatter for the default locale.
|
| Day | | public Day()(Code) | | Creates a new instance, derived from the system date/time (and assuming
the default timezone).
|
| Day | | public Day(int day, int month, int year)(Code) | | Constructs a new one day time period.
Parameters:
day - the day-of-the-month.
Parameters:
month - the month (1 to 12).
Parameters:
year - the year (1900 <= year <= 9999). |
| Day | | public Day(SerialDate serialDate)(Code) | | Constructs a new one day time period.
Parameters:
serialDate - the day (null not permitted). |
| Day | | public Day(Date time)(Code) | | Constructs a new instance, based on a particular date/time and the
default time zone.
Parameters:
time - the time (null not permitted). |
| Day | | public Day(Date time, TimeZone zone)(Code) | | Constructs a new instance, based on a particular date/time and time zone.
Parameters:
time - the date/time.
Parameters:
zone - the time zone. |
| compareTo | | public int compareTo(Object o1)(Code) | | Returns an integer indicating the order of this Day 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 obj)(Code) | | Tests the equality of this Day object to an arbitrary object. Returns
true if the target is a Day instance or a SerialDate instance
representing the same day as this object. In all other cases,
returns false.
Parameters:
obj - the object (null permitted). A flag indicating whether or not an object is equal to this day. |
| getDayOfMonth | | public int getDayOfMonth()(Code) | | Returns the day of the month.
The day of the month. |
| getFirstMillisecond | | public long getFirstMillisecond()(Code) | | Returns the first millisecond of the day. 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
Day.peg(Calendar) method.
The first millisecond of the day.
See Also: Day.getLastMillisecond() |
| getFirstMillisecond | | public long getFirstMillisecond(Calendar calendar)(Code) | | Returns the first millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - calendar to use (null not permitted). The start of the day as milliseconds since 01-01-1970.
throws:
NullPointerException - if calendar is null. |
| getLastMillisecond | | public long getLastMillisecond()(Code) | | Returns the last millisecond of the day. 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
Day.peg(Calendar) method.
The last millisecond of the day.
See Also: Day.getFirstMillisecond() |
| getLastMillisecond | | public long getLastMillisecond(Calendar calendar)(Code) | | Returns the last millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
Parameters:
calendar - calendar to use (null not permitted). The end of the day as milliseconds since 01-01-1970.
throws:
NullPointerException - if calendar is null. |
| getMonth | | public int getMonth()(Code) | | Returns the month.
The month. |
| getSerialDate | | public SerialDate getSerialDate()(Code) | | Returns the day as a
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).
The day as a SerialDate. |
| getSerialIndex | | public long getSerialIndex()(Code) | | Returns a serial index number for the day.
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 day following this one, or null if some limit
has been reached.
The day following this one, or null if some limit has been reached. |
| parseDay | | public static Day parseDay(String s)(Code) | | Parses the string argument as a day.
This method is required to recognise YYYY-MM-DD as a valid format.
Anything else, for now, is a bonus.
Parameters:
s - the date string to parse. null if the string does not contain any parseablestring, the day 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 |
| toString | | public String toString()(Code) | | Returns a string representing the day.
A string representing the day. |
|
|