java.util

Class GregorianCalendar

java.lang.Object

java.util.Calendar

java.util.GregorianCalendar

All Implemented Interfaces:

Cloneable

public class GregorianCalendar
extends Calendar

Field Summary

Fields

Modifier and Type	Field and Description
static int	AD
static int	BC

Fields inherited from class java.util.Calendar

AM, AM_PM, APRIL, areFieldsSet, AUGUST, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DST_OFFSET, ERA, FEBRUARY, FRIDAY, HOUR, HOUR_OF_DAY, isParamSet, isTimeSet, JANUARY, JULY, JUNE, MARCH, MAY, MILLISECOND, MINUTE, MONDAY, MONTH, NOVEMBER, OCTOBER, PARAM_COUNT, PM, SATURDAY, SECOND, SEPTEMBER, SUNDAY, THURSDAY, time, TUESDAY, tzParams, UNDECIMBER, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, YEAR, ZONE_OFFSET

Constructor Summary

Constructors

Constructor and Description
GregorianCalendar() Constructs a default GregorianCalendar using the current time in the default time zone.
GregorianCalendar(int year, int month, int day) Constructs a GregorianCalendar with the given date and time set for the default time zone.
GregorianCalendar(int year, int month, int day, int hrs, int mins) Constructs a GregorianCalendar with the given date and time set for the default time zone.
GregorianCalendar(int year, int month, int day, int hrs, int mins, int secs) Constructs a GregorianCalendar with the given date and time set for the default time zone.
GregorianCalendar(long time) Constructs a default GregorianCalendar using the specified time in the default time zone.
GregorianCalendar(TimeZone timezone) Constructs a default GregorianCalendar using the specified timezone.
GregorianCalendar(TimeZone timezone, long time) Constructs a GregorianCalendar based on the current time in the given time zone.

Method Summary

Modifier and Type	Method and Description
void	add(int field, int amount) Adds the specified (signed) amount of time to the given calendar field, based on the calendar's rules.
boolean	after(Object when) Returns whether this Calendar represents a time after the time represented by the specified Object.
boolean	before(Object when) Returns whether this Calendar represents a time before the time represented by the specified Object.
protected void	computeFields() Converts the current millisecond time value time to calendar field values in tzParams[].
protected void	computeTime() Converts the current calendar field values in tzParams[] to the millisecond time value time.
boolean	equals(Object obj) Compares two Objects for equality.
int	getGreatestMinimum(int i) Returns the highest minimum value for the given calendar field of this Calendar instance.
int	getLeastMaximum(int i) Returns the lowest maximum value for the given calendar field of this Calendar instance.
int	getMaximum(int i) Returns the maximum value for the given calendar field of this Calendar instance.
int	getMinimum(int i) Returns the minimum value for the given calendar field of this Calendar instance.
int	hashCode() Returns a hash code value for the object.
void	roll(int i, boolean flag) Adds or subtracts (up/down) a single unit of time on the given time field without changing larger tzParams.

Methods inherited from class java.util.Calendar

clear, clear, clone, complete, get, getFirstDayOfWeek, getInstance, getInstance, getMinimalDaysInFirstWeek, getTime, getTimeInMillis, getTimeZone, internalGet, isLenient, isSet, set, set, set, set, setFirstDayOfWeek, setLenient, setMinimalDaysInFirstWeek, setTime, setTimeInMillis, setTimeZone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

BC

public static final int BC

See Also:

Constant Field Values

AD

public static final int AD

See Also:

Constant Field Values

Constructor Detail

GregorianCalendar

public GregorianCalendar()

Constructs a default GregorianCalendar using the current time in the default time zone.

GregorianCalendar

public GregorianCalendar(long time)

Constructs a default GregorianCalendar using the specified time in the default time zone.

GregorianCalendar

public GregorianCalendar(TimeZone timezone)

Constructs a default GregorianCalendar using the specified timezone.

GregorianCalendar

public GregorianCalendar(int year,
                         int month,
                         int day)

Constructs a GregorianCalendar with the given date and time set for the default time zone.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for January.

day - the value used to set the DAY_OF_MONTH calendar field in the calendar.

GregorianCalendar

public GregorianCalendar(int year,
                         int month,
                         int day,
                         int hrs,
                         int mins)

Constructs a GregorianCalendar with the given date and time set for the default time zone.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for January.

day - the value used to set the DAY_OF_MONTH calendar field in the calendar.

hrs - the value used to set the HOUR_OF_DAY calendar field in the calendar.

mins - the value used to set the MINUTE calendar field in the calendar.

GregorianCalendar

public GregorianCalendar(int year,
                         int month,
                         int day,
                         int hrs,
                         int mins,
                         int secs)

Constructs a GregorianCalendar with the given date and time set for the default time zone.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for January.

day - the value used to set the DAY_OF_MONTH calendar field in the calendar.

hrs - the value used to set the HOUR_OF_DAY calendar field in the calendar.

mins - the value used to set the MINUTE calendar field in the calendar.

secs - the value used to set the SECOND calendar field in the calendar.

GregorianCalendar

public GregorianCalendar(TimeZone timezone,
                         long time)

Constructs a GregorianCalendar based on the current time in the given time zone.

Parameters:

timezone - the given time zone.

Method Detail

add

public void add(int field,
                int amount)

Adds the specified (signed) amount of time to the given calendar field, based on the calendar's rules.

Specified by:

add in class Calendar

Parameters:

field - the calendar field.

amount - the amount of date or time to be added to the field.

after

public boolean after(Object when)

Returns whether this Calendar represents a time after the time represented by the specified Object.

Specified by:

after in class Calendar

Parameters:

when - the Object to be compared

Returns:

true if the time of this Calendar is after the time represented by when; false otherwise.

before

public boolean before(Object when)

Returns whether this Calendar represents a time before the time represented by the specified Object.

Specified by:

before in class Calendar

Parameters:

when - he Object to be compared

Returns:

true if the time of this Calendar is before the time represented by when; false otherwise.

computeFields

protected void computeFields()

Description copied from class: Calendar

Converts the current millisecond time value time to calendar field values in tzParams[].

Specified by:

computeFields in class Calendar

computeTime

protected void computeTime()

Description copied from class: Calendar

Converts the current calendar field values in tzParams[] to the millisecond time value time.

Specified by:

computeTime in class Calendar

equals

public boolean equals(Object obj)

Description copied from class: Object

Compares two Objects for equality.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false.
• For any reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Specified by:

equals in class Calendar

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

getGreatestMinimum

public int getGreatestMinimum(int i)

Description copied from class: Calendar

Returns the highest minimum value for the given calendar field of this Calendar instance.

Specified by:

getGreatestMinimum in class Calendar

Parameters:

i - ?

Returns:

?

getLeastMaximum

public int getLeastMaximum(int i)

Description copied from class: Calendar

Returns the lowest maximum value for the given calendar field of this Calendar instance.

Specified by:

getLeastMaximum in class Calendar

Parameters:

i - ?

Returns:

?

getMaximum

public int getMaximum(int i)

Description copied from class: Calendar

Returns the maximum value for the given calendar field of this Calendar instance.

Specified by:

getMaximum in class Calendar

Parameters:

i - ?

Returns:

?

getMinimum

public int getMinimum(int i)

Description copied from class: Calendar

Returns the minimum value for the given calendar field of this Calendar instance. The minimum value is defined as the smallest value returned by the get method for any possible time value.

Specified by:

getMinimum in class Calendar

Parameters:

i - ?

Returns:

?

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

roll

public void roll(int i,
                 boolean flag)

Description copied from class: Calendar

Adds or subtracts (up/down) a single unit of time on the given time field without changing larger tzParams.

Specified by:

roll in class Calendar

Parameters:

i - the time field.

flag - indicates if the value of the specified time field is to be rolled up or rolled down. Use true if rolling up, false otherwise.