Package org.jfree.data.time
Class Minute
java.lang.Object
org.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Minute
- All Implemented Interfaces:
Serializable
,Comparable
,MonthConstants
,TimePeriod
public class Minute extends RegularTimePeriod implements Serializable
Represents a minute. This class is immutable, which is a requirement for
all
RegularTimePeriod
subclasses.- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description 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. -
Constructor Summary
Constructors Constructor Description Minute()
Constructs a new Minute, based on the system date/time.Minute(int minute, int hour, int day, int month, int year)
Creates a new minute.Minute(int minute, Hour hour)
Constructs a new Minute.Minute(Date time)
Constructs a new instance, based on the supplied date/time.Minute(Date time, Calendar calendar)
Constructs a new instance, based on a particular date/time.Minute(Date time, TimeZone zone, Locale locale)
Constructs a new Minute, based on the supplied date/time and timezone. -
Method Summary
Modifier and Type Method Description 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, getCalendarInstance, getEnd, getMiddleMillisecond, getMiddleMillisecond, getMillisecond, getStart, setCalendarInstancePrototype, setThreadLocalCalendarInstance, toString
-
Field Details
-
FIRST_MINUTE_IN_HOUR
Useful constant for the first minute in a day.- See Also:
- Constant Field Values
-
LAST_MINUTE_IN_HOUR
Useful constant for the last minute in a day.- See Also:
- Constant Field Values
-
-
Constructor Details
-
Minute
public Minute()Constructs a new Minute, based on the system date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
. -
Minute
Constructs a new Minute. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
minute
- the minute (0 to 59).hour
- the hour (null
not permitted).
-
Minute
Constructs a new instance, based on the supplied date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
time
- the time (null
not permitted).- See Also:
Minute(Date, TimeZone, Locale)
-
Minute
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).
-
Minute
Constructs a new instance, based on a particular date/time. The time zone and locale are determined by thecalendar
parameter.- Parameters:
time
- the date/time (null
not permitted).calendar
- the calendar to use for calculations (null
not permitted).
-
Minute
Creates a new minute. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- 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 Details
-
getDay
Returns the day.- Returns:
- The day.
-
getHour
Returns the hour.- Returns:
- The hour (never
null
).
-
getHourValue
Returns the hour.- Returns:
- The hour.
-
getMinute
Returns the minute.- Returns:
- The minute.
-
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 thepeg(Calendar)
method.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Returns:
- The first millisecond of the minute.
- See Also:
getLastMillisecond()
-
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 thepeg(Calendar)
method.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Returns:
- The last millisecond of the minute.
- See Also:
getFirstMillisecond()
-
peg
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).- Specified by:
peg
in classRegularTimePeriod
- Parameters:
calendar
- the calendar (null
not permitted).
-
previous
Returns the minute preceding this one. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- Specified by:
previous
in classRegularTimePeriod
- Returns:
- The minute preceding this one.
-
next
Returns the minute following this one. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- Specified by:
next
in classRegularTimePeriod
- Returns:
- The minute following this one.
-
getSerialIndex
Returns a serial index number for the minute.- Specified by:
getSerialIndex
in classRegularTimePeriod
- Returns:
- The serial index number.
-
getFirstMillisecond
Returns the first millisecond of the minute.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar which defines the timezone (null
not permitted).- Returns:
- The first millisecond.
- Throws:
NullPointerException
- ifcalendar
isnull
.- See Also:
RegularTimePeriod.getLastMillisecond(Calendar)
-
getLastMillisecond
Returns the last millisecond of the minute.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar / timezone (null
not permitted).- Returns:
- The last millisecond.
- Throws:
NullPointerException
- ifcalendar
isnull
.- See Also:
RegularTimePeriod.getFirstMillisecond(Calendar)
-
equals
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.
-
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
-
compareTo
Returns an integer indicating the order of this Minute object relative to the specified object: negative == before, zero == same, positive == after.- Specified by:
compareTo
in interfaceComparable
- Parameters:
o1
- object to compare.- Returns:
- negative == before, zero == same, positive == after.
-
parseMinute
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.
-