com.jrefinery.data
Class Hour

java.lang.Object
  |
  +--com.jrefinery.data.TimePeriod
        |
        +--com.jrefinery.data.Hour
All Implemented Interfaces:
java.lang.Comparable, com.jrefinery.date.MonthConstants

public class Hour
extends TimePeriod

Represents an hour in a specific day.

This class is immutable, which is a requirement for all TimePeriod subclasses.

Author:
DG

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 com.jrefinery.data.TimePeriod
DEFAULT_TIME_ZONE, WORKING_CALENDAR
 
Fields inherited from interface com.jrefinery.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 getEnd(java.util.Calendar calendar)
          Returns the last millisecond of the hour.
 int getHour()
          Returns the hour.
 int getMonth()
          Returns the month in which this hour falls.
 long getSerialIndex()
          Returns a serial index number for the hour.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the hour.
 int getYear()
          Returns the year in which this hour falls.
 TimePeriod next()
          Returns the hour following this one.
static Hour parseHour(java.lang.String s)
          Creates an Hour instance by parsing a string.
 TimePeriod previous()
          Returns the hour preceding this one.
 
Methods inherited from class com.jrefinery.data.TimePeriod
getEnd, getEnd, getMiddle, getMiddle, getMiddle, getStart, getStart
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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.
Constructor Detail

Hour

public Hour()
Constructs a new Hour, based on the system date/time.

Hour

public Hour(int hour,
            Day day)
Constructs a new Hour.
Parameters:
hour - the hour (in the range 0 to 23).
day - the day.

Hour

public Hour(java.util.Date time)
Constructs a new Hour, based on the supplied date/time.
Parameters:
time - the date-time.

Hour

public 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.
Parameters:
time - the date-time.
zone - the time zone.
Method Detail

getHour

public int getHour()
Returns the hour.
Returns:
the hour.

getDay

public Day 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

public TimePeriod previous()
Returns the hour preceding this one.
Overrides:
previous in class TimePeriod
Returns:
the hour preceding this one.

next

public TimePeriod next()
Returns the hour following this one.
Overrides:
next in class TimePeriod
Returns:
the hour following this one.

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the hour.
Overrides:
getSerialIndex in class TimePeriod
Returns:
The serial index number.

getStart

public long getStart(java.util.Calendar calendar)
Returns the first millisecond of the hour.
Overrides:
getStart in class TimePeriod
Parameters:
calendar - the calendar/timezone.
Returns:
the first millisecond.

getEnd

public long getEnd(java.util.Calendar calendar)
Returns the last millisecond of the hour.
Overrides:
getEnd in class TimePeriod
Parameters:
calendar - the calendar/timezone.
Returns:
the last millisecond.

equals

public boolean equals(java.lang.Object object)
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.

Overrides:
equals in class java.lang.Object
Parameters:
object - the object to compare.
Returns:
true if the hour and day value of the object is the same as this.

compareTo

public 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.
Parameters:
o1 - the object to compare.
Returns:
negative == before, zero == same, positive == after.

parseHour

public static Hour parseHour(java.lang.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.
Parameters:
s - the hour string to parse.
Returns:
null if the string is not parseable, the hour otherwise.