org.jfree.data.time

Class Minute

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 intFIRST_MINUTE_IN_HOUR
Useful constant for the first minute in a day.
static intLAST_MINUTE_IN_HOUR
Useful constant for the last minute in a day.
Constructor Summary
Minute()
Constructs a new Minute, based on the system date/time.
Minute(int minute, Hour hour)
Constructs a new Minute.
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.
Method Summary
intcompareTo(Object o1)
Returns an integer indicating the order of this Minute object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object obj)
Tests the equality of this object against an arbitrary Object.
DaygetDay()
Returns the day.
longgetFirstMillisecond()
Returns the first millisecond of the minute.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the minute.
HourgetHour()
Returns the hour.
intgetHourValue()
Returns the hour.
longgetLastMillisecond()
Returns the last millisecond of the minute.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the minute.
intgetMinute()
Returns the minute.
longgetSerialIndex()
Returns a serial index number for the minute.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the minute following this one.
static MinuteparseMinute(String s)
Creates a Minute instance by parsing a string.
voidpeg(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).
RegularTimePeriodprevious()
Returns the minute preceding this one.

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 (null not permitted).

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).

Method Detail

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 method.

Returns: The first millisecond of the minute.

See Also: getLastMillisecond

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the minute.

Parameters: calendar the calendar which defines the timezone (null not permitted).

Returns: The first millisecond.

Throws: NullPointerException if calendar is null.

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 method.

Returns: The last millisecond of the minute.

See Also: getFirstMillisecond

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the minute.

Parameters: calendar the calendar / timezone (null not permitted).

Returns: The last millisecond.

Throws: NullPointerException if calendar is null.

getMinute

public int getMinute()
Returns the minute.

Returns: The minute.

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the minute.

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.

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).

Parameters: calendar the calendar (null not permitted).

Since: 1.0.3

previous

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

Returns: The minute preceding this one.