org.jfree.data.time

Class Second

Implemented Interfaces:
Comparable, MonthConstants, Serializable, TimePeriod

public class Second
extends RegularTimePeriod
implements Serializable

Represents a second in a particular day. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Field Summary

static int
FIRST_SECOND_IN_MINUTE
Useful constant for the first second in a minute.
static int
LAST_SECOND_IN_MINUTE
Useful constant for the last second in a minute.

Fields inherited from class org.jfree.data.time.RegularTimePeriod

DEFAULT_TIME_ZONE, WORKING_CALENDAR

Constructor Summary

Second()
Constructs a new Second, based on the system date/time.
Second(Date time)
Constructs a second.
Second(Date time, TimeZone zone)
Creates a new second based on the supplied time and time zone.
Second(int second, int minute, int hour, int day, int month, int year)
Creates a new second.
Second(int second, Minute minute)
Constructs a new Second.

Method Summary

int
compareTo(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(Object obj)
Tests the equality of this object against an arbitrary Object.
long
getFirstMillisecond()
Returns the first millisecond of the second.
long
getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the minute.
long
getLastMillisecond()
Returns the last millisecond of the second.
long
getLastMillisecond(Calendar calendar)
Returns the last millisecond of the second.
Minute
getMinute()
Returns the minute.
int
getSecond()
Returns the second within the minute.
long
getSerialIndex()
Returns a serial index number for the minute.
int
hashCode()
Returns a hash code for this object instance.
RegularTimePeriod
next()
Returns the second following this one.
static Second
parseSecond(String s)
Creates a new instance by parsing a string.
void
peg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).
RegularTimePeriod
previous()
Returns the second preceding this one.

Methods inherited from class org.jfree.data.time.RegularTimePeriod

createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getSerialIndex, getStart, next, peg, previous, toString

Field Details

FIRST_SECOND_IN_MINUTE

public static final int FIRST_SECOND_IN_MINUTE
Useful constant for the first second in a minute.
Field Value:
0

LAST_SECOND_IN_MINUTE

public static final int LAST_SECOND_IN_MINUTE
Useful constant for the last second in a minute.
Field Value:
59

Constructor Details

Second

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

Second

public Second(Date time)
Constructs a second.
Parameters:
time - the time.

Second

public Second(Date time,
              TimeZone zone)
Creates a new second based on the supplied time and time zone.
Parameters:
time - the instant in time.
zone - the time zone.

Second

public Second(int second,
              int minute,
              int hour,
              int day,
              int month,
              int year)
Creates a new second.
Parameters:
second - the second (0-59).
minute - the minute (0-59).
hour - the hour (0-23).
day - the day (1-31).
month - the month (1-12).
year - the year (1900-9999).

Second

public Second(int second,
              Minute minute)
Constructs a new Second.
Parameters:
second - the second (0 to 24*60*60-1).
minute - the minute (null not permitted).

Method Details

compareTo

public int compareTo(Object o1)
Returns an integer indicating the order of this Second 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.

equals

public boolean equals(Object obj)
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.

Parameters:
obj - the object to compare (null permitted).
Returns:
true if second and minute of this and the object are the same.

getFirstMillisecond

public long getFirstMillisecond()
Returns the first millisecond of the second. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg(Calendar) method.
Overrides:
getFirstMillisecond in interface RegularTimePeriod
Returns:
The first millisecond of the second.

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the minute.
Overrides:
getFirstMillisecond in interface RegularTimePeriod
Parameters:
calendar - the calendar/timezone (null not permitted).
Returns:
The first millisecond.

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the second. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg(Calendar) method.
Overrides:
getLastMillisecond in interface RegularTimePeriod
Returns:
The last millisecond of the second.

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the second.
Overrides:
getLastMillisecond in interface RegularTimePeriod
Parameters:
calendar - the calendar/timezone (null not permitted).
Returns:
The last millisecond.

getMinute

public Minute getMinute()
Returns the minute.
Returns:
The minute (never null).

getSecond

public int getSecond()
Returns the second within the minute.
Returns:
The second (0 - 59).

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the minute.
Overrides:
getSerialIndex in interface RegularTimePeriod
Returns:
The serial index number.

hashCode

public int hashCode()
Returns a hash code for this object instance. The approach described by Joshua Bloch in "Effective Java" has been used here:

http://developer.java.sun.com/developer/Books/effectivejava /Chapter3.pdf

Returns:
A hash code.

next

public RegularTimePeriod next()
Returns the second following this one.
Overrides:
next in interface RegularTimePeriod
Returns:
The second following this one.

parseSecond

public static Second parseSecond(String s)
Creates a new 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.
Parameters:
s - the string to parse.
Returns:
The second, or null if the string is not parseable.

peg

public void peg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).
Overrides:
peg in interface RegularTimePeriod
Parameters:
calendar - the calendar (null not permitted).
Since:
1.0.3

previous

public RegularTimePeriod previous()
Returns the second preceding this one.
Overrides:
previous in interface RegularTimePeriod
Returns:
The second preceding this one.