Package org.jfree.data.time
Class Hour
java.lang.Object
org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Hour
- All Implemented Interfaces:
Serializable
,Comparable
,TimePeriod
,org.jfree.date.MonthConstants
public class Hour extends RegularTimePeriod implements Serializable
Represents an hour in a specific day.
This class is immutable, which is a requirement for all
RegularTimePeriod
subclasses.
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description Hour()
Constructs a new Hour, based on the system date/time.Hour(int hour, int day, int month, int year)
Creates a new hour.Hour(int hour, Day day)
Constructs a new Hour.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. -
Method Summary
Modifier and Type Method Description 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 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(Calendar calendar)
Returns the first millisecond of the hour.int
getHour()
Returns 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.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, toString
-
Field Details
-
FIRST_HOUR_IN_DAY
public static final int FIRST_HOUR_IN_DAYUseful constant for the first hour in the day.- See Also:
- Constant Field Values
-
LAST_HOUR_IN_DAY
public static final int LAST_HOUR_IN_DAYUseful constant for the last hour in the day.- See Also:
- Constant Field Values
-
-
Constructor Details
-
Hour
public Hour()Constructs a new Hour, based on the system date/time. -
Hour
Constructs a new Hour.- Parameters:
hour
- the hour (in the range 0 to 23).day
- the day.
-
Hour
public Hour(int hour, int day, int month, int year)Creates a new hour.- Parameters:
hour
- the hour (0-23).day
- the day (1-31).month
- the month (1-12).year
- the year (1900-9999).
-
Hour
Constructs a new Hour, based on the supplied date/time.- Parameters:
time
- the date-time.
-
Hour
Constructs a new Hour, based on the supplied date/time evaluated in the specified time zone.- Parameters:
time
- the date-time.zone
- the time zone.
-
-
Method Details
-
getHour
public int getHour()Returns the hour.- Returns:
- the hour.
-
getDay
Returns the day in which this hour falls.- Returns:
- the day.
-
getYear
public int getYear()Returns the year in which this hour falls.- Returns:
- the year.
-
getMonth
public int getMonth()Returns the month in which this hour falls.- Returns:
- the month.
-
getDayOfMonth
public int getDayOfMonth()Returns the day-of-the-month in which this hour falls.- Returns:
- the day-of-the-month.
-
previous
Returns the hour preceding this one.- Specified by:
previous
in classRegularTimePeriod
- Returns:
- the hour preceding this one.
-
next
Returns the hour following this one.- Specified by:
next
in classRegularTimePeriod
- Returns:
- the hour following this one.
-
getSerialIndex
public long getSerialIndex()Returns a serial index number for the hour.- Specified by:
getSerialIndex
in classRegularTimePeriod
- Returns:
- The serial index number.
-
getFirstMillisecond
Returns the first millisecond of the hour.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar/timezone.- Returns:
- the first millisecond.
-
getLastMillisecond
Returns the last millisecond of the hour.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar/timezone.- Returns:
- the last millisecond.
-
equals
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.
-
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 Hour 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.
-
parseHour
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.- Returns:
null
if the string is not parseable, the hour otherwise.
-