com.jrefinery.data
Class Hour

java.lang.Object
  extended by com.jrefinery.data.TimePeriod
      extended by com.jrefinery.data.Hour
All Implemented Interfaces:
MonthConstants, java.lang.Comparable

public class Hour
extends TimePeriod

Represents an hour in a specific day.

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


Field Summary
protected  Day day
          The day.
protected  int hour
          The hour.
 
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 time period, evaluated using the supplied calendar (which incorporates a timezone).
 int getHour()
          Returns the hour.
 int getMonth()
          Returns the month in which this hour falls.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
 int getYear()
          Returns the year in which this hour falls.
static void main(java.lang.String[] args)
          Test code - please ignore.
 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

day

protected Day day
The day.


hour

protected int hour
The hour.

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.


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.

Specified by:
previous in class TimePeriod
Returns:
The previous time period.

next

public TimePeriod next()
Returns the hour following this one.

Specified by:
next in class TimePeriod
Returns:
The next time period.

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

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.


getStart

public long getStart(java.util.Calendar calendar)
Description copied from class: TimePeriod
Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).

Specified by:
getStart in class TimePeriod
Parameters:
calendar - The calendar.
Returns:
The first millisecond of the time period.

getEnd

public long getEnd(java.util.Calendar calendar)
Description copied from class: TimePeriod
Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).

Specified by:
getEnd in class TimePeriod
Parameters:
calendar - The calendar.
Returns:
The last millisecond of the time period.

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.


main

public static void main(java.lang.String[] args)
Test code - please ignore.



Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.