com.jrefinery.data
Class Minute

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

public class Minute
extends TimePeriod

Represents a minute.

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


Field Summary
protected  Hour hour
          The hour in which the minute falls.
 
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
Minute()
          Constructs a new Minute, based on the system date/time.
Minute(java.util.Date time)
          Constructs a new Minute, based on the supplied date/time.
Minute(java.util.Date time, java.util.TimeZone zone)
           
Minute(int minute, Hour hour)
          Constructs a new Minute.
 
Method Summary
 int compareTo(java.lang.Object o1)
          Returns an integer indicating the order of this Minute 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.
 long getEnd(java.util.Calendar calendar)
          Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
 Hour getHour()
          Returns the day in which this minute falls.
 int getMinute()
          Returns the minute.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
static void main(java.lang.String[] args)
          Test code - please ignore.
 TimePeriod next()
          Returns the minute following this one.
static Minute parseMinute(java.lang.String s)
          Creates a Minute instance by parsing a string.
 TimePeriod previous()
          Returns the minute 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

hour

protected Hour hour
The hour in which the minute falls.

Constructor Detail

Minute

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


Minute

public Minute(int minute,
              Hour hour)
Constructs a new Minute.

Parameters:
minute - The minute (0 to 59).
day - The day.

Minute

public Minute(java.util.Date time)
Constructs a new Minute, based on the supplied date/time.

Parameters:
time - The time.

Minute

public Minute(java.util.Date time,
              java.util.TimeZone zone)
Method Detail

getHour

public Hour getHour()
Returns the day in which this minute falls.


getMinute

public int getMinute()
Returns the minute.


previous

public TimePeriod previous()
Returns the minute preceding this one.

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

next

public TimePeriod next()
Returns the minute 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 a Minute object representing the same minute 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 Minute 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.

parseMinute

public static Minute parseMinute(java.lang.String s)
Creates a Minute instance by parsing a string. The string is assumed to be in the format "YYYY-MM-DD HH:MM", 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.