org.jfree.data.time

Class Minute

Implemented Interfaces:
Comparable, MonthConstants, Serializable, TimePeriod

public class Minute
extends RegularTimePeriod
implements Serializable

Represents a minute. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

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 org.jfree.data.time.RegularTimePeriod

DEFAULT_TIME_ZONE, WORKING_CALENDAR

Constructor Summary

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

Method Summary

int
compareTo(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(Object obj)
Tests the equality of this object against an arbitrary Object.
Day
getDay()
Returns the day.
long
getFirstMillisecond()
Returns the first millisecond of the minute.
long
getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the minute.
Hour
getHour()
Returns the hour.
int
getHourValue()
Returns the hour.
long
getLastMillisecond()
Returns the last millisecond of the minute.
long
getLastMillisecond(Calendar calendar)
Returns the last millisecond of the minute.
int
getMinute()
Returns 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 minute following this one.
static Minute
parseMinute(String s)
Creates a Minute 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 minute 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_MINUTE_IN_HOUR

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

LAST_MINUTE_IN_HOUR

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

Constructor Details

Minute

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

Minute

public Minute(Date time)
Constructs a new Minute, based on the supplied date/time.
Parameters:
time - the time (null not permitted).

Minute

public Minute(Date time,
              TimeZone zone)
Constructs a new Minute, based on the supplied date/time and timezone.
Parameters:
time - the time (null not permitted).
zone - the time zone (null not permitted).

Minute

public Minute(int minute,
              int hour,
              int day,
              int month,
              int year)
Creates a new minute.
Parameters:
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).

Minute

public Minute(int minute,
              Hour hour)
Constructs a new Minute.
Parameters:
minute - the minute (0 to 59).
hour - the hour (null not permitted).

Method Details

compareTo

public int compareTo(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.

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 Minute object representing the same minute as this instance.

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

getDay

public Day getDay()
Returns the day.
Returns:
The day.
Since:
1.0.3

getFirstMillisecond

public long getFirstMillisecond()
Returns the first millisecond of the minute. 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 minute.

getFirstMillisecond

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

getHour

public Hour getHour()
Returns the hour.
Returns:
The hour (never null).

getHourValue

public int getHourValue()
Returns the hour.
Returns:
The hour.
Since:
1.0.3

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the minute. 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 minute.

getLastMillisecond

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

getMinute

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

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 minute following this one.
Overrides:
next in interface RegularTimePeriod
Returns:
The minute following this one.

parseMinute

public static Minute parseMinute(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.

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 minute preceding this one.
Overrides:
previous in interface RegularTimePeriod
Returns:
The minute preceding this one.