org.jfree.data.time
Class Day
- Comparable, MonthConstants, Serializable, TimePeriod
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.
protected static DateFormat | DATE_FORMAT- A standard date formatter.
|
protected static DateFormat | DATE_FORMAT_LONG- A date formatter for the default locale.
|
protected static DateFormat | DATE_FORMAT_MEDIUM- A date formatter for the default locale.
|
protected static DateFormat | DATE_FORMAT_SHORT- A date formatter for the default locale.
|
Day()- Creates a new instance, derived from the system date/time (and assuming
the default timezone).
|
Day(Date time)- Constructs a new instance, based on a particular date/time and the
default time zone.
|
Day(Date time, TimeZone zone)- Constructs a new instance, based on a particular date/time and time zone.
|
Day(SerialDate serialDate)- Constructs a new one day time period.
|
Day(int day, int month, int year)- Constructs a new one day time period.
|
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.
|
boolean | equals(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(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(Calendar calendar)- Returns the last millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
|
int | getMonth()- Returns the month.
|
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(String s)- Parses the string argument as a day.
|
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).
|
RegularTimePeriod | previous()- Returns the day preceding this one.
|
String | toString()- Returns a string representing the day.
|
createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getSerialIndex, getStart, next, peg, previous, toString |
DATE_FORMAT
protected static final DateFormat DATE_FORMAT
A standard date formatter.
DATE_FORMAT_LONG
protected static final DateFormat DATE_FORMAT_LONG
A date formatter for the default locale.
DATE_FORMAT_MEDIUM
protected static final DateFormat DATE_FORMAT_MEDIUM
A date formatter for the default locale.
DATE_FORMAT_SHORT
protected static final DateFormat DATE_FORMAT_SHORT
A date formatter for the default locale.
Day
public Day()
Creates a new instance, derived from the system date/time (and assuming
the default timezone).
Day
public Day(Date time)
Constructs a new instance, based on a particular date/time and the
default time zone.
time - the time (null not permitted).
Day
public Day(Date time,
TimeZone zone) Constructs a new instance, based on a particular date/time and time zone.
time - the date/time.zone - the time zone.
Day
public Day(SerialDate serialDate)
Constructs a new one day time period.
serialDate - the day (null not permitted).
Day
public Day(int day,
int month,
int year) Constructs a new one day time period.
day - the day-of-the-month.month - the month (1 to 12).year - the year (1900 <= year <= 9999).
compareTo
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.
o1 - the object to compare.
- negative == before, zero == same, positive == after.
equals
public boolean equals(Object obj)
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.
obj - the object (null permitted).
- A flag indicating whether or not an object is equal to this day.
getDayOfMonth
public int getDayOfMonth()
Returns the day of the month.
getFirstMillisecond
public long getFirstMillisecond()
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
peg(Calendar) method.
- getFirstMillisecond in interface RegularTimePeriod
- The first millisecond of the day.
getFirstMillisecond
public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
- getFirstMillisecond in interface RegularTimePeriod
calendar - calendar to use (null not permitted).
- The start of the day as milliseconds since 01-01-1970.
getLastMillisecond
public long getLastMillisecond()
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
peg(Calendar) method.
- getLastMillisecond in interface RegularTimePeriod
- The last millisecond of the day.
getLastMillisecond
public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the day, evaluated using the supplied
calendar (which determines the time zone).
- getLastMillisecond in interface RegularTimePeriod
calendar - calendar to use (null not permitted).
- The end of the day as milliseconds since 01-01-1970.
getMonth
public int getMonth()
Returns the month.
getSerialDate
public SerialDate getSerialDate()
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).
getYear
public int getYear()
Returns the year.
hashCode
public int hashCode()
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
next
public RegularTimePeriod next()
Returns the day following this one, or null if some limit
has been reached.
- next in interface RegularTimePeriod
- The day following this one, or
null if some limit
has been reached.
parseDay
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.
s - the date string to parse.
null if the string does not contain any parseable
string, the day otherwise.
peg
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).
- peg in interface RegularTimePeriod
calendar - the calendar (null not permitted).