com.jrefinery.data
Class Second

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

public class Second
extends TimePeriod

Represents a second in a particular day.

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


Field Summary
protected  Minute minute
          The day.
protected  int second
          The second.
 
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
Second()
          Constructs a new Second, based on the system date/time.
Second(java.util.Date time)
          Constructs a second.
Second(java.util.Date time, java.util.TimeZone zone)
           
Second(int second, Minute minute)
          Constructs a new Second.
 
Method Summary
 int compareTo(java.lang.Object o1)
          Returns an integer indicating the order of this Second 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).
 Minute getMinute()
          Returns the minute.
 int getSecond()
          Returns the second.
 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 second following this one.
static Second parseSecond(java.lang.String s)
          Creates a Minute instance by parsing a string.
 TimePeriod previous()
          Returns the second 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

minute

protected Minute minute
The day.


second

protected int second
The second.

Constructor Detail

Second

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


Second

public Second(int second,
              Minute minute)
Constructs a new Second.

Parameters:
second - The second (0 to 24*60*60-1).
day - The day.

Second

public Second(java.util.Date time)
Constructs a second.

Parameters:
time - The time.

Second

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

getSecond

public int getSecond()
Returns the second.


getMinute

public Minute getMinute()
Returns the minute.


previous

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

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

next

public TimePeriod next()
Returns the second 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 Second object representing the same second 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 Second 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.

parseSecond

public static Second parseSecond(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:SS", 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.