org.jfree.data.time
Class Hour
- Comparable, MonthConstants, Serializable, TimePeriod
Represents an hour in a specific day. This class is immutable, which is a
requirement for all
RegularTimePeriod subclasses.
Hour()- Constructs a new Hour, based on the system date/time.
|
Hour(Date time)- Constructs a new Hour, based on the supplied date/time.
|
Hour(Date time, TimeZone zone)- Constructs a new Hour, based on the supplied date/time evaluated in the
specified time zone.
|
Hour(int hour, int day, int month, int year)- Creates a new hour.
|
Hour(int hour, Day day)- Constructs a new Hour.
|
int | compareTo(Object o1)- Returns an integer indicating the order of this Hour object relative to
the specified object:
negative == before, zero == same, positive == after.
|
boolean | equals(Object obj)- Tests the equality of this object against an arbitrary Object.
|
Day | getDay()- Returns the day in which this hour falls.
|
int | getDayOfMonth()- Returns the day-of-the-month in which this hour falls.
|
long | getFirstMillisecond()- Returns the first millisecond of the hour.
|
long | getFirstMillisecond(Calendar calendar)- Returns the first millisecond of the hour.
|
int | getHour()- Returns the hour.
|
long | getLastMillisecond()- Returns the last millisecond of the hour.
|
long | getLastMillisecond(Calendar calendar)- Returns the last millisecond of the hour.
|
int | getMonth()- Returns the month in which this hour falls.
|
long | getSerialIndex()- Returns a serial index number for the hour.
|
int | getYear()- Returns the year in which this hour falls.
|
int | hashCode()- Returns a hash code for this object instance.
|
RegularTimePeriod | next()- Returns the hour following this one.
|
static Hour | parseHour(String s)- Creates an Hour instance by parsing a string.
|
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 hour preceding this one.
|
createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getSerialIndex, getStart, next, peg, previous, toString |
FIRST_HOUR_IN_DAY
public static final int FIRST_HOUR_IN_DAY
Useful constant for the first hour in the day.
LAST_HOUR_IN_DAY
public static final int LAST_HOUR_IN_DAY
Useful constant for the last hour in the day.
Hour
public Hour()
Constructs a new Hour, based on the system date/time.
Hour
public Hour(Date time)
Constructs a new Hour, based on the supplied date/time.
time - the date-time (null not permitted).
Hour
public Hour(Date time,
TimeZone zone) Constructs a new Hour, based on the supplied date/time evaluated in the
specified time zone.
time - the date-time (null not permitted).zone - the time zone (null not permitted).
Hour
public Hour(int hour,
int day,
int month,
int year) Creates a new hour.
hour - the hour (0-23).day - the day (1-31).month - the month (1-12).year - the year (1900-9999).
Hour
public Hour(int hour,
Day day) Constructs a new Hour.
hour - the hour (in the range 0 to 23).day - the day (null not permitted).
compareTo
public int compareTo(Object o1)
Returns an integer indicating the order of this Hour 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 object against an arbitrary Object.
This method will return true ONLY if the object is an Hour object
representing the same hour as this instance.
obj - the object to compare (null permitted).
true if the hour and day value of the object
is the same as this.
getDay
public Day getDay()
Returns the day in which this hour falls.
getDayOfMonth
public int getDayOfMonth()
Returns the day-of-the-month in which this hour falls.
getFirstMillisecond
public long getFirstMillisecond()
Returns the first millisecond of the hour. 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 hour.
getHour
public int getHour()
Returns the hour.
- The hour (0 <= hour <= 23).
getLastMillisecond
public long getLastMillisecond()
Returns the last millisecond of the hour. 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 hour.
getMonth
public int getMonth()
Returns the month in which this hour falls.
getYear
public int getYear()
Returns the year in which this hour falls.
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
parseHour
public static Hour parseHour(String s)
Creates an Hour instance by parsing a string. The string is assumed to
be in the format "YYYY-MM-DD HH", perhaps with leading or trailing
whitespace.
s - the hour string to parse.
null if the string is not parseable, the hour
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).