org.jfree.data.time

Class Year

public class Year extends RegularTimePeriod implements Serializable

Represents a year in the range -9999 to 9999. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.
Field Summary
static intMAXIMUM_YEAR
The maximum year value.
static intMINIMUM_YEAR
The minimum year value.
Constructor Summary
Year()
Creates a new Year, based on the current system date/time.
Year(int year)
Creates a time period representing a single year.
Year(Date time)
Creates a new Year, based on a particular instant in time, using the default time zone.
Year(Date time, TimeZone zone)
Constructs a year, based on a particular instant in time and a time zone.
Year(Date time, TimeZone zone, Locale locale)
Creates a new Year instance, for the specified time zone and locale.
Method Summary
intcompareTo(Object o1)
Returns an integer indicating the order of this Year object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object obj)
Tests the equality of this Year object to an arbitrary object.
longgetFirstMillisecond()
Returns the first millisecond of the year.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied calendar (which determines the time zone).
longgetLastMillisecond()
Returns the last millisecond of the year.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the year, evaluated using the supplied calendar (which determines the time zone).
longgetSerialIndex()
Returns a serial index number for the year.
intgetYear()
Returns the year.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the year following this one.
static YearparseYear(String s)
Parses the string argument as a year.
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 year preceding this one.
StringtoString()
Returns a string representing the year..

Field Detail

MAXIMUM_YEAR

public static final int MAXIMUM_YEAR
The maximum year value.

Since: 1.0.11

MINIMUM_YEAR

public static final int MINIMUM_YEAR
The minimum year value.

Since: 1.0.11

Constructor Detail

Year

public Year()
Creates a new Year, based on the current system date/time.

Year

public Year(int year)
Creates a time period representing a single year.

Parameters: year the year.

Year

public Year(Date time)
Creates a new Year, based on a particular instant in time, using the default time zone.

Parameters: time the time (null not permitted).

See Also: Year

Year

public Year(Date time, TimeZone zone)

Deprecated: Since 1.0.12, use Year instead.

Constructs a year, based on a particular instant in time and a time zone.

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

Year

public Year(Date time, TimeZone zone, Locale locale)
Creates a new Year instance, for the specified time zone and locale.

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

Since: 1.0.12

Method Detail

compareTo

public int compareTo(Object o1)
Returns an integer indicating the order of this Year 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 Year object to an arbitrary object. Returns true if the target is a Year instance representing the same year as this object. In all other cases, returns false.

Parameters: obj the object (null permitted).

Returns: true if the year of this and the object are the same.

getFirstMillisecond

public long getFirstMillisecond()
Returns the first millisecond of the year. 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 year.

See Also: getLastMillisecond

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied calendar (which determines the time zone).

Parameters: calendar the calendar (null not permitted).

Returns: The first millisecond of the year.

Throws: NullPointerException if calendar is null.

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the year. 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 year.

See Also: getFirstMillisecond

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the year, evaluated using the supplied calendar (which determines the time zone).

Parameters: calendar the calendar (null not permitted).

Returns: The last millisecond of the year.

Throws: NullPointerException if calendar is null.

getSerialIndex

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

The implementation simply returns the year number (e.g. 2002).

Returns: The serial index number.

getYear

public int getYear()
Returns the year.

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.

next

public RegularTimePeriod next()
Returns the year following this one.

Returns: The year following this one (or null if the current year is 9999).

parseYear

public static Year parseYear(String s)
Parses the string argument as a year.

The string format is YYYY.

Parameters: s a string representing the year.

Returns: null if the string is not parseable, the year 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 year preceding this one.

Returns: The year preceding this one (or null if the current year is -9999).

toString

public String toString()
Returns a string representing the year..

Returns: A string representing the year.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.