public class

Year

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

Class Overview

Represents a year in the range -9999 to 9999. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Summary

Constants
int MAXIMUM_YEAR The maximum year value.
int MINIMUM_YEAR The minimum year value.
[Expand]
Inherited Fields
From class org.jfree.data.time.RegularTimePeriod
Public Constructors
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)
This constructor is deprecated. Since 1.0.12, use Year(Date, TimeZone, Locale) instead.
Year(Date time, TimeZone zone, Locale locale)
Creates a new Year instance, for the specified time zone and locale.
Public Methods
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.
boolean equals(Object obj)
Tests the equality of this Year object to an arbitrary object.
long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the year, evaluated using the supplied calendar (which determines the time zone).
long getFirstMillisecond()
Returns the first millisecond of the year.
long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the year, evaluated using the supplied calendar (which determines the time zone).
long getLastMillisecond()
Returns the last millisecond of the year.
long getSerialIndex()
Returns a serial index number for the year.
int getYear()
Returns the year.
int hashCode()
Returns a hash code for this object instance.
RegularTimePeriod next()
Returns the year following this one.
static Year parseYear(String s)
Parses the string argument as a year.
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 year preceding this one.
String toString()
Returns a string representing the year..
[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 MAXIMUM_YEAR

The maximum year value.

Constant Value: 9999 (0x0000270f)

public static final int MINIMUM_YEAR

The minimum year value.

Constant Value: -9999 (0xffffd8f1)

Public Constructors

public Year ()

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

public Year (int year)

Creates a time period representing a single year.

Parameters
year the 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

public Year (Date time, TimeZone zone)

This constructor is deprecated.
Since 1.0.12, use Year(Date, TimeZone, Locale) 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.

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.

Public Methods

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.

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.

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.

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

Returns
  • The first millisecond of the year.
See Also

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.

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

Returns
  • The last millisecond of the year.
See Also

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.

public int getYear ()

Returns the year.

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 year following this one.

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

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.

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

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

public String toString ()

Returns a string representing the year..

Returns
  • A string representing the year.