com.jrefinery.data
Class Minute

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

public class Minute
extends TimePeriod

Represents a minute.

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

Author:
DG

Field Summary
static int FIRST_MINUTE_IN_HOUR
          Useful constant for the first minute in a day.
static int LAST_MINUTE_IN_HOUR
          Useful constant for the last minute in a 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
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)
          Constructs a new Minute, based on the supplied date/time and timezone.
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 minute.
 Hour getHour()
          Returns the hour.
 int getMinute()
          Returns the minute.
 long getSerialIndex()
          Returns a serial index number for the minute.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the minute.
 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

FIRST_MINUTE_IN_HOUR

public static final int FIRST_MINUTE_IN_HOUR
Useful constant for the first minute in a day.

LAST_MINUTE_IN_HOUR

public static final int LAST_MINUTE_IN_HOUR
Useful constant for the last minute in a day.
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).
hour - the hour.

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)
Constructs a new Minute, based on the supplied date/time and timezone.
Parameters:
time - the time.
zone - the time zone.
Method Detail

getHour

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

getMinute

public int getMinute()
Returns the minute.
Returns:
the minute.

previous

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

next

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

getSerialIndex

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

getStart

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

getEnd

public long getEnd(java.util.Calendar calendar)
Returns the last millisecond of the minute.
Overrides:
getEnd in class TimePeriod
Parameters:
calendar - the calendar and 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 a Minute object representing the same minute as this instance.

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

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

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.
Parameters:
s - the minute string to parse.
Returns:
null, if the string is not parseable, the minute otherwise.