public class

Quarter

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

Class Overview

Defines a quarter (in a given year). The range supported is Q1 1900 to Q4 9999. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Summary

Constants
int FIRST_QUARTER Constant for quarter 1.
int LAST_QUARTER Constant for quarter 4.
Fields
public static final int[] FIRST_MONTH_IN_QUARTER The first month in each quarter.
public static final int[] LAST_MONTH_IN_QUARTER The last month in each quarter.
[Expand]
Inherited Fields
From class org.jfree.data.time.RegularTimePeriod
Public Constructors
Quarter()
Constructs a new Quarter, based on the current system date/time.
Quarter(int quarter, int year)
Constructs a new quarter.
Quarter(int quarter, Year year)
Constructs a new quarter.
Quarter(Date time)
Constructs a new instance, based on a date/time and the default time zone.
Quarter(Date time, TimeZone zone)
This constructor is deprecated. Since 1.0.12, use Quarter(Date, TimeZone, Locale) instead.
Quarter(Date time, TimeZone zone, Locale locale)
Creates a new Quarter instance, using the specified zone and locale.
Public Methods
int compareTo(Object o1)
Returns an integer indicating the order of this Quarter object relative to the specified object: negative == before, zero == same, positive == after.
boolean equals(Object obj)
Tests the equality of this Quarter object to an arbitrary object.
long getFirstMillisecond(Calendar calendar)
Returns the first millisecond in the Quarter, evaluated using the supplied calendar (which determines the time zone).
long getFirstMillisecond()
Returns the first millisecond of the quarter.
long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the Quarter, evaluated using the supplied calendar (which determines the time zone).
long getLastMillisecond()
Returns the last millisecond of the quarter.
int getQuarter()
Returns the quarter.
long getSerialIndex()
Returns a serial index number for the quarter.
Year getYear()
Returns the year.
int getYearValue()
Returns the year.
int hashCode()
Returns a hash code for this object instance.
RegularTimePeriod next()
Returns the quarter following this one.
static Quarter parseQuarter(String s)
Parses the string argument as a quarter.
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 quarter preceding this one.
String toString()
Returns a string representing the quarter (e.g.
[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 FIRST_QUARTER

Constant for quarter 1.

Constant Value: 1 (0x00000001)

public static final int LAST_QUARTER

Constant for quarter 4.

Constant Value: 4 (0x00000004)

Fields

public static final int[] FIRST_MONTH_IN_QUARTER

The first month in each quarter.

public static final int[] LAST_MONTH_IN_QUARTER

The last month in each quarter.

Public Constructors

public Quarter ()

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

public Quarter (int quarter, int year)

Constructs a new quarter.

Parameters
quarter the quarter (1 to 4).
year the year (1900 to 9999).

public Quarter (int quarter, Year year)

Constructs a new quarter.

Parameters
quarter the quarter (1 to 4).
year the year (1900 to 9999).

public Quarter (Date time)

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

Parameters
time the date/time (null not permitted).
See Also

public Quarter (Date time, TimeZone zone)

This constructor is deprecated.
Since 1.0.12, use Quarter(Date, TimeZone, Locale) instead.

Constructs a Quarter, based on a date/time and time zone.

Parameters
time the date/time.
zone the zone (null not permitted).

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

Creates a new Quarter instance, using the specified zone and locale.

Parameters
time the current time.
zone the time zone.
locale the locale.

Public Methods

public int compareTo (Object o1)

Returns an integer indicating the order of this Quarter 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 Quarter object to an arbitrary object. Returns true if the target is a Quarter instance representing the same quarter as this object. In all other cases, returns false.

Parameters
obj the object (null permitted).
Returns
  • true if quarter and year of this and the object are the same.

public long getFirstMillisecond (Calendar calendar)

Returns the first millisecond in the Quarter, evaluated using the supplied calendar (which determines the time zone).

Parameters
calendar the calendar (null not permitted).
Returns
  • The first millisecond in the Quarter.
Throws
NullPointerException if calendar is null.

public long getFirstMillisecond ()

Returns the first millisecond of the quarter. 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 quarter.
See Also

public long getLastMillisecond (Calendar calendar)

Returns the last millisecond of the Quarter, evaluated using the supplied calendar (which determines the time zone).

Parameters
calendar the calendar (null not permitted).
Returns
  • The last millisecond of the Quarter.
Throws
NullPointerException if calendar is null.

public long getLastMillisecond ()

Returns the last millisecond of the quarter. 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 quarter.
See Also

public int getQuarter ()

Returns the quarter.

Returns
  • The quarter.

public long getSerialIndex ()

Returns a serial index number for the quarter.

Returns
  • The serial index number.

public Year getYear ()

Returns the year.

Returns
  • The year.

public int getYearValue ()

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

Returns
  • The quarter following this one (or null if this is Q4 9999).

public static Quarter parseQuarter (String s)

Parses the string argument as a quarter.

This method should accept the following formats: "YYYY-QN" and "QN-YYYY", where the "-" can be a space, a forward-slash (/), comma or a dash (-).

Parameters
s A string representing the quarter.
Returns
  • The quarter.

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

Returns
  • The quarter preceding this one (or null if this is Q1 1900).

public String toString ()

Returns a string representing the quarter (e.g. "Q1/2002").

Returns
  • A string representing the quarter.