org.jfree.data.time

Class Hour

public class Hour extends RegularTimePeriod implements Serializable

Represents an hour in a specific day. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Field Summary
static int	FIRST_HOUR_IN_DAY Useful constant for the first hour in the day.
static int	LAST_HOUR_IN_DAY Useful constant for the last hour in the day.

Constructor Summary
	Hour() Constructs a new Hour, based on the system date/time.
	Hour(int hour, Day day) Constructs a new Hour.
	Hour(int hour, int day, int month, int year) Creates a new hour.
	Hour(Date time) Constructs a new instance, based on the supplied date/time and the default time zone.
	Hour(Date time, TimeZone zone) Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.
	Hour(Date time, TimeZone zone, Locale locale) Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.

Method Summary
int	compareTo(Object o1) Returns an integer indicating the order of this Hour 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 in which this hour falls.
int	getDayOfMonth() Returns the day-of-the-month in which this hour falls.
long	getFirstMillisecond() Returns the first millisecond of the hour.
long	getFirstMillisecond(Calendar calendar) Returns the first millisecond of the hour.
int	getHour() Returns the hour.
long	getLastMillisecond() Returns the last millisecond of the hour.
long	getLastMillisecond(Calendar calendar) Returns the last millisecond of the hour.
int	getMonth() Returns the month in which this hour falls.
long	getSerialIndex() Returns a serial index number for the hour.
int	getYear() Returns the year in which this hour falls.
int	hashCode() Returns a hash code for this object instance.
RegularTimePeriod	next() Returns the hour following this one.
static Hour	parseHour(String s) Creates an Hour 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 hour preceding this one.
String	toString() Returns a string representation of this instance, for debugging purposes.

Field Detail

FIRST_HOUR_IN_DAY

public static final int FIRST_HOUR_IN_DAY

Useful constant for the first hour in the day.

LAST_HOUR_IN_DAY

public static final int LAST_HOUR_IN_DAY

Useful constant for the last hour in the day.

Constructor Detail

Hour

public Hour()

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

Hour

public Hour(int hour, Day day)

Constructs a new Hour.

Parameters: hour the hour (in the range 0 to 23). day the day (null not permitted).

Hour

public Hour(int hour, int day, int month, int year)

Creates a new hour.

Parameters: hour the hour (0-23). day the day (1-31). month the month (1-12). year the year (1900-9999).

Hour

public Hour(Date time)

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

Parameters: time the date-time (null not permitted).

Hour

public Hour(Date time, TimeZone zone)

Deprecated: As of 1.0.13, use the constructor that specifies the locale also.

Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.

Parameters: time the date-time (null not permitted). zone the time zone (null not permitted).

Hour

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

Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.

Parameters: time the date-time (null not permitted). zone the time zone (null not permitted). locale the locale (null not permitted).

Since: 1.0.13

Method Detail

compareTo

public int compareTo(Object o1)

Returns an integer indicating the order of this Hour 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 an Hour object representing the same hour as this instance.

Parameters: obj the object to compare (null permitted).

Returns: true if the hour and day value of the object is the same as this.

getDay

public Day getDay()

Returns the day in which this hour falls.

Returns: The day.

getDayOfMonth

public int getDayOfMonth()

Returns the day-of-the-month in which this hour falls.

Returns: The day-of-the-month.

Returns the first millisecond of the hour. 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 hour.

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)

Returns the first millisecond of the hour.

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

Returns: The first millisecond.

Throws: NullPointerException if calendar is null.

getHour

public int getHour()

Returns the hour.

Returns: The hour (0 <= hour <= 23).

getLastMillisecond

public long getLastMillisecond()

Returns the last millisecond of the hour. 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 hour.

getLastMillisecond

public long getLastMillisecond(Calendar calendar)

Returns the last millisecond of the hour.

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

Returns: The last millisecond.

Throws: NullPointerException if calendar is null.

getMonth

public int getMonth()

Returns the month in which this hour falls.

Returns: The month.

getSerialIndex

public long getSerialIndex()

Returns a serial index number for the hour.

Returns: The serial index number.

getYear

public int getYear()

Returns the year in which this hour falls.

Returns: The year.

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.

public RegularTimePeriod next()

Returns the hour following this one.

Returns: The hour following this one.

parseHour

public static Hour parseHour(String s)

Creates an Hour instance by parsing a string. The string is assumed to be in the format "YYYY-MM-DD HH", perhaps with leading or trailing whitespace.

Parameters: s the hour string to parse.

Returns: null if the string is not parseable, the hour 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

public RegularTimePeriod previous()

Returns the hour preceding this one.

Returns: The hour preceding this one.

toString

public String toString()

Returns a string representation of this instance, for debugging purposes.

Returns: A string.

Header
And More

Class Hour

Field Detail

FIRST_HOUR_IN_DAY

LAST_HOUR_IN_DAY

Constructor Detail

Hour

Hour

Hour

Hour

Hour

Hour

Method Detail

compareTo

equals

getDay

getDayOfMonth

getFirstMillisecond

getFirstMillisecond

getHour

getLastMillisecond

getLastMillisecond

getMonth

getSerialIndex

getYear

hashCode

next

parseHour

peg

previous

toString

Footer
And More

HeaderAnd More

Class Hour

FooterAnd More

Header
And More

Footer
And More