org.jfree.data.time

Class Day

public class Day extends RegularTimePeriod implements Serializable

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 DateFormatDATE_FORMAT
A standard date formatter.
protected static DateFormatDATE_FORMAT_LONG
A date formatter for the default locale.
protected static DateFormatDATE_FORMAT_MEDIUM
A date formatter for the default locale.
protected static DateFormatDATE_FORMAT_SHORT
A date formatter for the default locale.
Constructor Summary
Day()
Creates a new instance, derived from the system date/time (and assuming the default timezone).
Day(int day, int month, int year)
Constructs a new one day time period.
Day(SerialDate serialDate)
Constructs a new one day time period.
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.
Method Summary
intcompareTo(Object o1)
Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object obj)
Tests the equality of this Day object to an arbitrary object.
intgetDayOfMonth()
Returns the day of the month.
longgetFirstMillisecond()
Returns the first millisecond of the day.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
longgetLastMillisecond()
Returns the last millisecond of the day.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
intgetMonth()
Returns the month.
SerialDategetSerialDate()
Returns the day as a SerialDate.
longgetSerialIndex()
Returns a serial index number for the day.
intgetYear()
Returns the year.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the day following this one, or null if some limit has been reached.
static DayparseDay(String s)
Parses the string argument as a day.
voidpeg(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).
RegularTimePeriodprevious()
Returns the day preceding this one.
StringtoString()
Returns a string representing the day.

Field Detail

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.

Constructor Detail

Day

public Day()
Creates a new instance, derived from the system date/time (and assuming the default timezone).

Day

public Day(int day, int month, int year)
Constructs a new one day time period.

Parameters: day the day-of-the-month. month the month (1 to 12). year the year (1900 <= year <= 9999).

Day

public Day(SerialDate serialDate)
Constructs a new one day time period.

Parameters: serialDate the day (null not permitted).

Day

public Day(Date time)
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)
Constructs a new instance, based on a particular date/time and time zone.

Parameters: time the date/time. zone the time zone.

Method Detail

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.

Parameters: o1 the object to compare.

Returns: 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.

Parameters: obj the object (null permitted).

Returns: A flag indicating whether or not an object is equal to this day.

getDayOfMonth

public int getDayOfMonth()
Returns the day of the month.

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 method.

Returns: The first millisecond of the day.

See Also: getLastMillisecond

getFirstMillisecond

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).

Returns: The start of the day as milliseconds since 01-01-1970.

Throws: NullPointerException if calendar is null.

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 method.

Returns: The last millisecond of the day.

See Also: getFirstMillisecond

getLastMillisecond

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).

Returns: The end of the day as milliseconds since 01-01-1970.

Throws: NullPointerException if calendar is null.

getMonth

public int getMonth()
Returns the month.

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).

Returns: The day as a SerialDate.

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the day.

Returns: The serial index number.

getYear

public int getYear()
Returns the year.

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

Returns: A hash code.

next

public RegularTimePeriod next()
Returns the day following this one, or null if some limit has been reached.

Returns: 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.

Parameters: s the date string to parse.

Returns: 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).

Parameters: calendar the calendar (null not permitted).

Since: 1.0.3

previous

public RegularTimePeriod previous()
Returns the day preceding this one.

Returns: The day preceding this one.

toString

public String toString()
Returns a string representing the day.

Returns: A string representing the day.