public class

Day

extends RegularTimePeriod
implements Serializable
java.lang.Object
   ↳ org.jfree.data.time.RegularTimePeriod
     ↳ org.jfree.data.time.Day

Class Overview

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.

Summary

Fields
protected static final DateFormat DATE_FORMAT A standard date formatter.
protected static final DateFormat DATE_FORMAT_LONG A date formatter for the default locale.
protected static final DateFormat DATE_FORMAT_MEDIUM A date formatter for the default locale.
protected static final DateFormat DATE_FORMAT_SHORT A date formatter for the default locale.
[Expand]
Inherited Fields
From class org.jfree.data.time.RegularTimePeriod
Public Constructors
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, TimeZone zone)
This constructor is deprecated. As of 1.0.13, use the constructor that specifies the locale also.
Day(Date time, TimeZone zone, Locale locale)
Constructs a new instance, based on a particular date/time and time zone.
Public Methods
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(Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
long getFirstMillisecond()
Returns the first 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).
long getLastMillisecond()
Returns the last millisecond of the day.
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.
[Expand]
Inherited Methods
From class org.jfree.data.time.RegularTimePeriod
From class java.lang.Object
From interface java.lang.Comparable
From interface org.jfree.data.time.TimePeriod

Fields

protected static final DateFormat DATE_FORMAT

A standard date formatter.

protected static final DateFormat DATE_FORMAT_LONG

A date formatter for the default locale.

protected static final DateFormat DATE_FORMAT_MEDIUM

A date formatter for the default locale.

protected static final DateFormat DATE_FORMAT_SHORT

A date formatter for the default locale.

Public Constructors

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.

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

public Day (SerialDate serialDate)

Constructs a new one day time period.

Parameters
serialDate the day (null not permitted).

public Day (Date time, TimeZone zone)

This constructor is deprecated.
As of 1.0.13, use the constructor that specifies the locale also.

Constructs a new instance, based on a particular date/time and time zone.

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

public Day (Date time, TimeZone zone, Locale locale)

Constructs a new instance, based on a particular date/time and time zone.

Parameters
time the date/time (null not permitted).
zone the time zone (null not permitted).
locale the locale (null not permitted).

Public Methods

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.

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.

public int getDayOfMonth ()

Returns the day of the month.

Returns
  • The day of the month.

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.

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.

Returns
  • The first millisecond of the day.
See Also

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.

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.

Returns
  • The last millisecond of the day.
See Also

public int getMonth ()

Returns the month.

Returns
  • The month.

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.

public long getSerialIndex ()

Returns a serial index number for the day.

Returns
  • The serial index number.

public int getYear ()

Returns the year.

Returns
  • The year.

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.

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.

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.

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

public RegularTimePeriod previous ()

Returns the day preceding this one.

Returns
  • The day preceding this one.

public String toString ()

Returns a string representing the day.

Returns
  • A string representing the day.