|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jfree.data.time.RegularTimePeriod | +--org.jfree.data.time.Hour
Represents an hour in a specific day.
This class is immutable, which is a requirement for all RegularTimePeriod
subclasses.
Field Summary | |
static int |
FIRST_HOUR_IN_DAY
Useful constant for the first hour in the day. |
static int |
LAST_HOUR_IN_DAY
Useful constant for the last hour in the day. |
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 | |
Hour()
Constructs a new Hour, based on the system date/time. |
|
Hour(java.util.Date time)
Constructs a new Hour, based on the supplied date/time. |
|
Hour(java.util.Date time,
java.util.TimeZone zone)
Constructs a new Hour, based on the supplied date/time evaluated in the specified time zone. |
|
Hour(int hour,
Day day)
Constructs a new Hour. |
Method Summary | |
int |
compareTo(java.lang.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(java.lang.Object object)
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(java.util.Calendar calendar)
Returns the first millisecond of the hour. |
int |
getHour()
Returns the hour. |
long |
getLastMillisecond(java.util.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. |
RegularTimePeriod |
next()
Returns the hour following this one. |
static Hour |
parseHour(java.lang.String s)
Creates an Hour instance by parsing a string. |
RegularTimePeriod |
previous()
Returns the hour preceding this one. |
Methods inherited from class org.jfree.data.time.RegularTimePeriod |
getEnd, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getStart |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int FIRST_HOUR_IN_DAY
public static final int LAST_HOUR_IN_DAY
Constructor Detail |
public Hour()
public Hour(int hour, Day day)
hour
- the hour (in the range 0 to 23).day
- the day.public Hour(java.util.Date time)
time
- the date-time.public Hour(java.util.Date time, java.util.TimeZone zone)
time
- the date-time.zone
- the time zone.Method Detail |
public int getHour()
public Day getDay()
public int getYear()
public int getMonth()
public int getDayOfMonth()
public RegularTimePeriod previous()
previous
in class RegularTimePeriod
public RegularTimePeriod next()
next
in class RegularTimePeriod
public long getSerialIndex()
getSerialIndex
in class RegularTimePeriod
public long getFirstMillisecond(java.util.Calendar calendar)
getFirstMillisecond
in class RegularTimePeriod
calendar
- the calendar/timezone.
public long getLastMillisecond(java.util.Calendar calendar)
getLastMillisecond
in class RegularTimePeriod
calendar
- the calendar/timezone.
public boolean equals(java.lang.Object object)
This method will return true ONLY if the object is an Hour object representing the same hour as this instance.
equals
in class java.lang.Object
object
- the object to compare.
true
if the hour and day value of the object
is the same as this.public int compareTo(java.lang.Object o1)
compareTo
in interface java.lang.Comparable
o1
- the object to compare.
public static Hour parseHour(java.lang.String s)
s
- the hour string to parse.
null
if the string is not parseable, the hour otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |