public class

Minute

extends RegularTimePeriod
implements Serializable
java.lang.Object
   ↳ org.jfree.data.time.RegularTimePeriod
     ↳ org.jfree.data.time.Minute

Class Overview

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

Summary

Constants
int FIRST_MINUTE_IN_HOUR Useful constant for the first minute in a day.
int LAST_MINUTE_IN_HOUR Useful constant for the last minute in a day.
[Expand]
Inherited Fields
From class org.jfree.data.time.RegularTimePeriod
Public Constructors
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 instance, based on the supplied date/time and the default time zone.
Minute(Date time, TimeZone zone)
This constructor is deprecated. As of 1.0.13, use the constructor that specifies the locale also.
Minute(Date time, TimeZone zone, Locale locale)
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.
Public Methods
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(Calendar calendar)
Returns the first millisecond of the minute.
long getFirstMillisecond()
Returns the first millisecond of the minute.
Hour getHour()
Returns the hour.
int getHourValue()
Returns the hour.
long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the minute.
long getLastMillisecond()
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.
[Expand]
Inherited Methods
From class org.jfree.data.time.RegularTimePeriod
From class java.lang.Object
From interface java.lang.Comparable
From interface org.jfree.data.time.TimePeriod

Constants

public static final int FIRST_MINUTE_IN_HOUR

Useful constant for the first minute in a day.

Constant Value: 0 (0x00000000)

public static final int LAST_MINUTE_IN_HOUR

Useful constant for the last minute in a day.

Constant Value: 59 (0x0000003b)

Public Constructors

public Minute ()

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

public Minute (int minute, Hour hour)

Constructs a new Minute.

Parameters
minute the minute (0 to 59).
hour the hour (null not permitted).

public Minute (Date time)

Constructs a new instance, based on the supplied date/time and the default time zone.

Parameters
time the time (null not permitted).

public Minute (Date time, TimeZone zone)

This constructor is deprecated.
As of 1.0.13, use the constructor that specifies the locale also.

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

public Minute (Date time, TimeZone zone, Locale locale)

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

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

Public Methods

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.

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.

public Day getDay ()

Returns the day.

Returns
  • The day.

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.

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.

Returns
  • The first millisecond of the minute.

public Hour getHour ()

Returns the hour.

Returns
  • The hour (never null).

public int getHourValue ()

Returns the hour.

Returns
  • The hour.

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.

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.

Returns
  • The last millisecond of the minute.

public int getMinute ()

Returns the minute.

Returns
  • The minute.

public long getSerialIndex ()

Returns a serial index number for the minute.

Returns
  • The serial index number.

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.

public RegularTimePeriod next ()

Returns the minute following this one.

Returns
  • The minute following this one.

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.

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

public RegularTimePeriod previous ()

Returns the minute preceding this one.

Returns
  • The minute preceding this one.