| java.lang.Object
 org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Hour
| Field Summary | |
| final public static int | FIRST_HOUR_IN_DAY
Useful constant for the first hour in the day. | | final public static int | LAST_HOUR_IN_DAY
Useful constant for the last hour in the day. |
| Constructor Summary | |
| public | Hour()
Constructs a new Hour, based on the system date/time. | | public | Hour(int hour, Day day)
Constructs a new Hour. | | public | Hour(int hour, int day, int month, int year)
Creates a new hour. | | public | Hour(Date time)
Constructs a new Hour, based on the supplied date/time. | | public | Hour(Date time, TimeZone zone)
Constructs a new Hour, based on the supplied date/time evaluated in the
specified time zone. |
| Method Summary | |
| 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.
Parameters:
o1 - the object to compare. | | 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.
Parameters:
obj - the object to compare (null permitted). | | public Day | getDay()
Returns the day in which this hour falls. | | public int | getDayOfMonth()
Returns the day-of-the-month in which this hour falls. | | public long | getFirstMillisecond()
Returns the first millisecond of the hour. | | public long | getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the hour.
Parameters:
calendar - the calendar/timezone (null not permitted). | | public int | getHour()
Returns the hour. | | public long | getLastMillisecond()
Returns the last millisecond of the hour. | | public long | getLastMillisecond(Calendar calendar)
Returns the last millisecond of the hour.
Parameters:
calendar - the calendar/timezone (null not permitted). | | public int | getMonth()
Returns the month in which this hour falls. | | public long | getSerialIndex()
Returns a serial index number for the hour. | | public int | getYear()
Returns the year in which this hour falls. | | public int | hashCode()
Returns a hash code for this object instance. | | public RegularTimePeriod | next()
Returns the hour following this one. | | public static Hour | parseHour(String s)
Creates an Hour instance by parsing a string. | | 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). | | public RegularTimePeriod | previous()
Returns the hour preceding this one. |
| FIRST_HOUR_IN_DAY | | final public static int FIRST_HOUR_IN_DAY(Code) | | Useful constant for the first hour in the day.
|
| LAST_HOUR_IN_DAY | | final public static int LAST_HOUR_IN_DAY(Code) | | Useful constant for the last hour in the day.
|
| Hour | | public Hour()(Code) | | Constructs a new Hour, based on the system date/time.
|
| Hour | | public Hour(int hour, Day day)(Code) | | Constructs a new Hour.
Parameters:
hour - the hour (in the range 0 to 23).
Parameters:
day - the day (null not permitted). |
| Hour | | public Hour(int hour, int day, int month, int year)(Code) | | Creates a new hour.
Parameters:
hour - the hour (0-23).
Parameters:
day - the day (1-31).
Parameters:
month - the month (1-12).
Parameters:
year - the year (1900-9999). |
| Hour | | public Hour(Date time)(Code) | | Constructs a new Hour, based on the supplied date/time.
Parameters:
time - the date-time (null not permitted). |
| Hour | | public Hour(Date time, TimeZone zone)(Code) | | Constructs a new Hour, based on the supplied date/time evaluated in the
specified time zone.
Parameters:
time - the date-time (null not permitted).
Parameters:
zone - the time zone (null not permitted). |
| compareTo | | public int compareTo(Object o1)(Code) | | Returns an integer indicating the order of this Hour object relative to
the specified object:
negative == before, zero == same, positive == after.
Parameters:
o1 - the object to compare. negative == before, zero == same, positive == after. |
| equals | | public boolean equals(Object obj)(Code) | | 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.
Parameters:
obj - the object to compare (null permitted). true if the hour and day value of the objectis the same as this. |
| getDay | | public Day getDay()(Code) | | Returns the day in which this hour falls.
The day. |
| getDayOfMonth | | public int getDayOfMonth()(Code) | | Returns the day-of-the-month in which this hour falls.
The day-of-the-month. |
| getFirstMillisecond | | public long getFirstMillisecond()(Code) | | 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
Hour.peg(Calendar) method.
The first millisecond of the hour.
See Also: Hour.getLastMillisecond() |
| getFirstMillisecond | | public long getFirstMillisecond(Calendar calendar)(Code) | | Returns the first millisecond of the hour.
Parameters:
calendar - the calendar/timezone (null not permitted). The first millisecond.
throws:
NullPointerException - if calendar is null. |
| getHour | | public int getHour()(Code) | | Returns the hour.
The hour (0 <= hour <= 23). |
| getLastMillisecond | | public long getLastMillisecond()(Code) | | 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
Hour.peg(Calendar) method.
The last millisecond of the hour.
See Also: Hour.getFirstMillisecond() |
| getLastMillisecond | | public long getLastMillisecond(Calendar calendar)(Code) | | Returns the last millisecond of the hour.
Parameters:
calendar - the calendar/timezone (null not permitted). The last millisecond.
throws:
NullPointerException - if calendar is null. |
| getMonth | | public int getMonth()(Code) | | Returns the month in which this hour falls.
The month. |
| getSerialIndex | | public long getSerialIndex()(Code) | | Returns a serial index number for the hour.
The serial index number. |
| getYear | | public int getYear()(Code) | | Returns the year in which this hour falls.
The year. |
| hashCode | | public int hashCode()(Code) | | 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
A hash code. |
| parseHour | | public static Hour parseHour(String s)(Code) | | 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.
Parameters:
s - the hour string to parse. null if the string is not parseable, the hour otherwise. |
| peg | | public void peg(Calendar calendar)(Code) | | 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()(Code) | | Returns the hour preceding this one.
The hour preceding this one. |
|
|