public class

Hour

extends RegularTimePeriod
implements Serializable

java.lang.Object
↳	org.jfree.data.time.RegularTimePeriod
	↳	org.jfree.data.time.Hour

Class Overview

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

Summary

Constants
int	FIRST_HOUR_IN_DAY	Useful constant for the first hour in the day.
int	LAST_HOUR_IN_DAY	Useful constant for the last hour in the day.

[Expand]

Inherited Fields

From class org.jfree.data.time.RegularTimePeriod

Public Constructors
	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) This constructor is deprecated. As of 1.0.13, use the constructor that specifies the locale also.
	Hour(Date time, TimeZone zone, Locale locale) Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.

Public Methods
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(Calendar calendar) Returns the first millisecond of the hour.
long	getFirstMillisecond() Returns the first millisecond of the hour.
int	getHour() Returns the hour.
long	getLastMillisecond(Calendar calendar) Returns the last millisecond of the hour.
long	getLastMillisecond() 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.

[Expand]

Inherited Methods

From class org.jfree.data.time.RegularTimePeriod

static RegularTimePeriod	createInstance(Class c, Date millisecond, TimeZone zone) Creates a time period that includes the specified millisecond, assuming the given time zone.
static Class	downsize(Class c) Returns a subclass of `RegularTimePeriod` that is smaller than the specified class.
Date	getEnd() Returns the date/time that marks the end of the time period.
abstract long	getFirstMillisecond(Calendar calendar) Returns the first millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
long	getFirstMillisecond(TimeZone zone) This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call `getFirstMillisecond(Calendar)` instead.
abstract long	getFirstMillisecond() Returns the first millisecond of the time period.
long	getLastMillisecond(TimeZone zone) This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call `getLastMillisecond(Calendar)` instead.
abstract long	getLastMillisecond(Calendar calendar) Returns the last millisecond of the time period, evaluated using the supplied calendar (which incorporates a timezone).
abstract long	getLastMillisecond() Returns the last millisecond of the time period.
long	getMiddleMillisecond(Calendar calendar) Returns the millisecond closest to the middle of the time period, evaluated using the supplied calendar (which incorporates a timezone).
long	getMiddleMillisecond() Returns the millisecond closest to the middle of the time period.
long	getMiddleMillisecond(TimeZone zone) This method is deprecated. As of 1.0.3, you should avoid using this method (it creates a new Calendar instance every time it is called). You are advised to call `getMiddleMillisecond(Calendar)` instead.
abstract long	getSerialIndex() Returns a serial index number for the time unit.
Date	getStart() Returns the date/time that marks the start of the time period.
abstract RegularTimePeriod	next() Returns the time period following this one, or `null` if some limit has been reached.
abstract 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).
abstract RegularTimePeriod	previous() Returns the time period preceding this one, or `null` if some lower limit has been reached.
String	toString() Returns a string representation of the time period.

From class java.lang.Object

From interface java.lang.Comparable

From interface org.jfree.data.time.TimePeriod

Constants

public static final int FIRST_HOUR_IN_DAY

Useful constant for the first hour in the day.

Constant Value: 0 (0x00000000)

public static final int LAST_HOUR_IN_DAY

Useful constant for the last hour in the day.

Constant Value: 23 (0x00000017)

Public Constructors

public Hour ()

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

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

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

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

public Hour (Date time, TimeZone zone)

This constructor is 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).

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

Public Methods

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.

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.

public Day getDay ()

Returns the day in which this hour falls.

Returns

The day.

public int getDayOfMonth ()

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

Returns

The day-of-the-month.

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

public long getFirstMillisecond ()

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(Calendar) method.

Returns

The first millisecond of the hour.

public int getHour ()

Returns the hour.

Returns

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

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

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(Calendar) method.

Returns

The last millisecond of the hour.

public int getMonth ()

Returns the month in which this hour falls.

Returns

The month.

public long getSerialIndex ()

Returns a serial index number for the hour.

Returns

The serial index number.

public int getYear ()

Returns the year in which this hour falls.

Returns

The year.

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.

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.

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 hour preceding this one.

Returns

The hour preceding this one.

public String toString ()

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

Returns

A string.

Interfaces

Classes

Exceptions

Hour

Class Overview

Summary

Constants

public static final int FIRST_HOUR_IN_DAY

public static final int LAST_HOUR_IN_DAY

Public Constructors

public Hour ()

public Hour (int hour, Day day)

Parameters

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

Parameters

public Hour (Date time)

Parameters

See Also

public Hour (Date time, TimeZone zone)

Parameters

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

Parameters

Public Methods

public int compareTo (Object o1)

Parameters

Returns

public boolean equals (Object obj)

Parameters

Returns

public Day getDay ()

Returns

public int getDayOfMonth ()

Returns

public long getFirstMillisecond (Calendar calendar)

Parameters

Returns

Throws

public long getFirstMillisecond ()

Returns

See Also

public int getHour ()

Returns

public long getLastMillisecond (Calendar calendar)

Parameters

Returns

Throws

public long getLastMillisecond ()

Returns

See Also

public int getMonth ()

Returns

public long getSerialIndex ()

Returns

public int getYear ()

Returns

public int hashCode ()

Returns

public RegularTimePeriod next ()

Returns

public static Hour parseHour (String s)

Parameters

Returns

public void peg (Calendar calendar)

Parameters

public RegularTimePeriod previous ()

Returns

public String toString ()

Returns