Package org.jfree.data.time
Class Day
- java.lang.Object
-
- org.jfree.data.time.RegularTimePeriod
-
- org.jfree.data.time.Day
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable
,MonthConstants
,TimePeriod
public class Day extends RegularTimePeriod implements java.io.Serializable
Represents a single day in the range 1-Jan-1900 to 31-Dec-9999. This class is immutable, which is a requirement for allRegularTimePeriod
subclasses.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.text.DateFormat
DATE_FORMAT
A standard date formatter.protected static java.text.DateFormat
DATE_FORMAT_LONG
A date formatter for the default locale.protected static java.text.DateFormat
DATE_FORMAT_MEDIUM
A date formatter for the default locale.protected static java.text.DateFormat
DATE_FORMAT_SHORT
A date formatter for the default locale.private long
firstMillisecond
The first millisecond.private long
lastMillisecond
The last millisecond.private SerialDate
serialDate
The day (uses SerialDate for convenience).private static long
serialVersionUID
For serialization.
-
Constructor Summary
Constructors Constructor Description Day()
Creates a new instance, derived from the system date/time.Day(int day, int month, int year)
Constructs a new one day time period.Day(java.util.Date time)
Constructs a new instance, based on a particular date/time.Day(java.util.Date time, java.util.Calendar calendar)
Constructs a new instance, based on a particular date/time.Day(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)
Constructs a new instance, based on a particular date/time and time zone.Day(SerialDate serialDate)
Constructs a new one day time period.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.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(java.lang.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(java.util.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(java.util.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 aSerialDate
.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.private void
initUsing(java.util.Calendar calendar)
RegularTimePeriod
next()
Returns the day following this one, ornull
if some limit has been reached.static Day
parseDay(java.lang.String s)
Parses the string argument as a day.void
peg(java.util.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.java.lang.String
toString()
Returns a string representing the day.-
Methods inherited from class org.jfree.data.time.RegularTimePeriod
createInstance, downsize, getCalendarInstance, getEnd, getMiddleMillisecond, getMiddleMillisecond, getMillisecond, getStart, setCalendarInstancePrototype, setThreadLocalCalendarInstance
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
DATE_FORMAT
protected static final java.text.DateFormat DATE_FORMAT
A standard date formatter.
-
DATE_FORMAT_SHORT
protected static final java.text.DateFormat DATE_FORMAT_SHORT
A date formatter for the default locale.
-
DATE_FORMAT_MEDIUM
protected static final java.text.DateFormat DATE_FORMAT_MEDIUM
A date formatter for the default locale.
-
DATE_FORMAT_LONG
protected static final java.text.DateFormat DATE_FORMAT_LONG
A date formatter for the default locale.
-
serialDate
private SerialDate serialDate
The day (uses SerialDate for convenience).
-
firstMillisecond
private long firstMillisecond
The first millisecond.
-
lastMillisecond
private long lastMillisecond
The last millisecond.
-
-
Constructor Detail
-
Day
public Day()
Creates a new instance, derived from the system date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.
-
Day
public Day(int day, int month, int year)
Constructs a new one day time period. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- 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. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
serialDate
- the day (null
not permitted).
-
Day
public Day(java.util.Date time)
Constructs a new instance, based on a particular date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
time
- the time (null
not permitted).- See Also:
Day(Date, TimeZone, Locale)
-
Day
public Day(java.util.Date time, java.util.TimeZone zone, java.util.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).
-
Day
public Day(java.util.Date time, java.util.Calendar calendar)
Constructs a new instance, based on a particular date/time. The time zone and locale are determined by thecalendar
parameter.- Parameters:
time
- the date/time (null
not permitted).calendar
- the calendar to use for calculations (null
not permitted).
-
-
Method Detail
-
initUsing
private void initUsing(java.util.Calendar calendar)
-
getSerialDate
public SerialDate getSerialDate()
Returns the day as aSerialDate
. Note: the reference that is returned should be an instance of an immutableSerialDate
(otherwise the caller could use the reference to alter the state of thisDay
instance, andDay
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.
-
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 thepeg(Calendar)
method.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Returns:
- The first millisecond of the day.
- See Also:
getLastMillisecond()
-
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 thepeg(Calendar)
method.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Returns:
- The last millisecond of the day.
- See Also:
getFirstMillisecond()
-
peg
public void peg(java.util.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).- Specified by:
peg
in classRegularTimePeriod
- Parameters:
calendar
- the calendar (null
not permitted).
-
previous
public RegularTimePeriod previous()
Returns the day preceding this one. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- Specified by:
previous
in classRegularTimePeriod
- Returns:
- The day preceding this one.
-
next
public RegularTimePeriod next()
Returns the day following this one, ornull
if some limit has been reached. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- 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
public long getFirstMillisecond(java.util.Calendar calendar)
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 (null
not permitted).- Returns:
- The start of the day as milliseconds since 01-01-1970.
- Throws:
java.lang.NullPointerException
- ifcalendar
isnull
.- See Also:
RegularTimePeriod.getLastMillisecond(Calendar)
-
getLastMillisecond
public long getLastMillisecond(java.util.Calendar calendar)
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 (null
not permitted).- Returns:
- The end of the day as milliseconds since 01-01-1970.
- Throws:
java.lang.NullPointerException
- ifcalendar
isnull
.- See Also:
RegularTimePeriod.getFirstMillisecond(Calendar)
-
equals
public boolean equals(java.lang.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.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object (null
permitted).- Returns:
- A flag indicating whether or not an object is equal to this day.
-
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
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- A hash code.
-
compareTo
public int compareTo(java.lang.Object o1)
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 interfacejava.lang.Comparable
- Parameters:
o1
- the object to compare.- Returns:
- negative == before, zero == same, positive == after.
-
toString
public java.lang.String toString()
Returns a string representing the day.- Overrides:
toString
in classRegularTimePeriod
- Returns:
- A string representing the day.
-
parseDay
public static Day parseDay(java.lang.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.
-
-