Package org.jfree.data.time
Class Day
java.lang.Object
org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Day
- All Implemented Interfaces:
Serializable
,Comparable
,TimePeriod
,org.jfree.date.MonthConstants
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.
- See Also:
- Serialized Form
-
Field Summary
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
Constructors Constructor Description Day()
Constructs a Day, based on the system date/time.Day(int day, int month, int year)
Constructs a new one day time period.Day(Date time)
Constructs a new Day, based on a particular date/time and the default time zone.Day(Date time, TimeZone zone)
Constructs a Day, based on a particular date/time and time zone.Day(org.jfree.date.SerialDate serialDate)
Constructs a new one day time period. -
Method Summary
Modifier and Type Method Description 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 object)
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
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.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(String s)
Parses the string argument as a day.RegularTimePeriod
previous()
Returns the day preceding this one.String
toString()
Returns a string representing the day.Methods inherited from class org.jfree.data.time.RegularTimePeriod
getEnd, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getStart
-
Constructor Details
-
Day
public Day()Constructs a Day, based on the system date/time. -
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(org.jfree.date.SerialDate serialDate)Constructs a new one day time period.- Parameters:
serialDate
- the day.
-
Day
Constructs a new Day, based on a particular date/time and the default time zone.- Parameters:
time
- the time.
-
Day
Constructs a Day, based on a particular date/time and time zone.- Parameters:
time
- the date/time.zone
- the time zone.
-
-
Method Details
-
getSerialDate
public org.jfree.date.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.
-
getYear
public int getYear()Returns the year.- Returns:
- the year.
-
getMonth
public int getMonth()Returns the month.- Returns:
- the month.
-
getDayOfMonth
public int getDayOfMonth()Returns the day of the month.- Returns:
- the day of the month.
-
previous
Returns the day preceding this one.- Specified by:
previous
in classRegularTimePeriod
- Returns:
- the day preceding this one.
-
next
Returns the day following this one, or null if some limit has been reached.- Specified by:
next
in classRegularTimePeriod
- Returns:
- the day following this one, or
null
if some limit has been reached.
-
getSerialIndex
public long getSerialIndex()Returns a serial index number for the day.- Specified by:
getSerialIndex
in classRegularTimePeriod
- Returns:
- the serial index number.
-
getFirstMillisecond
Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- calendar to use.- Returns:
- the start of the day as milliseconds since 01-01-1970.
-
getLastMillisecond
Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone).- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- calendar to use.- Returns:
- the end of the day as milliseconds since 01-01-1970.
-
equals
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. -
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
-
compareTo
Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after.- Specified by:
compareTo
in interfaceComparable
- Parameters:
o1
- the object to compare.- Returns:
- negative == before, zero == same, positive == after.
-
toString
Returns a string representing the day.- Overrides:
toString
in classRegularTimePeriod
- Returns:
- A string representing the day.
-
parseDay
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.
-