java.util
Class Calendar

java.lang.Object
  |
  +--java.util.Calendar

All Implemented Interfaces:

Cloneable, Serializable

Direct Known Subclasses:

GregorianCalendar

public abstract class Calendar

extends Object

implements Serializable, Cloneable

Untamed:

See Also:

Serialized Form

Field Summary

static int	AM Enabled: Value of the AM_PM field indicating the period of the day from midnight to just before noon.
static int	AM_PM Enabled: Field number for get and set indicating whether the HOUR is before or after noon.
static int	APRIL Enabled: Value of the MONTH field indicating the fourth month of the year.
(package private) boolean	areAllFieldsSet True if all fields have been set.
protected boolean	areFieldsSet True if fields[] are in sync with the currently set time.
static int	AUGUST Enabled: Value of the MONTH field indicating the eighth month of the year.
private static Hashtable	cachedLocaleData Cache to hold the firstDayOfWeek and minimalDaysInFirstWeek of a Locale.
(package private) static int	currentSerialVersion
static int	DATE Enabled: Field number for get and set indicating the day of the month.
static int	DAY_OF_MONTH Enabled: Field number for get and set indicating the day of the month.
static int	DAY_OF_WEEK Enabled: Field number for get and set indicating the day of the week.
static int	DAY_OF_WEEK_IN_MONTH Enabled: Field number for get and set indicating the ordinal number of the day of the week within the current month.
static int	DAY_OF_YEAR Enabled: Field number for get and set indicating the day number within the current year.
static int	DECEMBER Enabled: Value of the MONTH field indicating the twelfth month of the year.
static int	DST_OFFSET Enabled: Field number for get and set indicating the daylight savings offset in milliseconds.
static int	ERA Enabled: Field number for get and set indicating the era, e.g., AD or BC in the Julian calendar.
static int	FEBRUARY Enabled: Value of the MONTH field indicating the second month of the year.
static int	FIELD_COUNT Enabled: The number of distinct fields recognized by get and set.
private static String[]	FIELD_NAME
protected int[]	fields The field values for the currently set time for this calendar.
private int	firstDayOfWeek The first day of the week, with possible values SUNDAY, MONDAY, etc.
static int	FRIDAY Enabled: Value of the DAY_OF_WEEK field indicating Friday.
static int	HOUR Enabled: Field number for get and set indicating the hour of the morning or afternoon.
static int	HOUR_OF_DAY Enabled: Field number for get and set indicating the hour of the day.
(package private) static int	INTERNALLY_SET
protected boolean[]	isSet The flags which tell if a specified time field for the calendar is set.
protected boolean	isTimeSet True if then the value of time is valid.
static int	JANUARY Enabled: Value of the MONTH field indicating the first month of the year.
static int	JULY Enabled: Value of the MONTH field indicating the seventh month of the year.
static int	JUNE Enabled: Value of the MONTH field indicating the sixth month of the year.
private boolean	lenient True if this calendar allows out-of-range field values during computation of time from fields[].
static int	MARCH Enabled: Value of the MONTH field indicating the third month of the year.
static int	MAY Enabled: Value of the MONTH field indicating the fifth month of the year.
static int	MILLISECOND Enabled: Field number for get and set indicating the millisecond within the second.
private int	minimalDaysInFirstWeek The number of days required for the first week in a month or year, with possible values from 1 to 7.
(package private) static int	MINIMUM_USER_STAMP
static int	MINUTE Enabled: Field number for get and set indicating the minute within the hour.
static int	MONDAY Enabled: Value of the DAY_OF_WEEK field indicating Monday.
static int	MONTH Enabled: Field number for get and set indicating the month.
private int	nextStamp The next available value for stamp[], an internal array.
static int	NOVEMBER Enabled: Value of the MONTH field indicating the eleventh month of the year.
static int	OCTOBER Enabled: Value of the MONTH field indicating the tenth month of the year.
static int	PM Enabled: Value of the AM_PM field indicating the period of the day from noon to just before midnight.
static int	SATURDAY Enabled: Value of the DAY_OF_WEEK field indicating Saturday.
static int	SECOND Enabled: Field number for get and set indicating the second within the minute.
static int	SEPTEMBER Enabled: Value of the MONTH field indicating the ninth month of the year.
private int	serialVersionOnStream The version of the serialized data on the stream.
(package private) static long	serialVersionUID
(package private) int[]	stamp Pseudo-time-stamps which specify when each field was set.
static int	SUNDAY Enabled: Value of the DAY_OF_WEEK field indicating Sunday.
static int	THURSDAY Enabled: Value of the DAY_OF_WEEK field indicating Thursday.
protected long	time The currently set time for this calendar, expressed in milliseconds after January 1, 1970, 0:00:00 GMT.
static int	TUESDAY Enabled: Value of the DAY_OF_WEEK field indicating Tuesday.
static int	UNDECIMBER Enabled: Value of the MONTH field indicating the thirteenth month of the year.
(package private) static int	UNSET
static int	WEDNESDAY Enabled: Value of the DAY_OF_WEEK field indicating Wednesday.
static int	WEEK_OF_MONTH Enabled: Field number for get and set indicating the week number within the current month.
static int	WEEK_OF_YEAR Enabled: Field number for get and set indicating the week number within the current year.
static int	YEAR Enabled: Field number for get and set indicating the year.
private TimeZone	zone The TimeZone used by this calendar.
static int	ZONE_OFFSET Enabled: Field number for get and set indicating the raw offset from GMT in milliseconds.

Constructor Summary

protected	Calendar() Constructs a Calendar with the default time zone and locale.
protected	Calendar(TimeZone zone, Locale aLocale) Constructs a calendar with the specified time zone and locale.

Method Summary

abstract void	add(int field, int amount) Enabled: Date Arithmetic function.
private void	adjustStamp() Adjusts the stamp[] values before nextStamp overflow.
boolean	after(Object when) Enabled: Compares the time field records.
boolean	before(Object when) Enabled: Compares the time field records.
void	clear() Enabled: Clears the values of all the time fields.
void	clear(int field) Enabled: Clears the value in the given time field.
Object	clone() Suppressed: Overrides Cloneable
protected void	complete() Fills in any unset fields in the time field list.
protected abstract void	computeFields() Converts the current millisecond time value time to field values in fields[].
protected abstract void	computeTime() Converts the current field values in fields[] to the millisecond time value time.
private static Calendar	createCalendar(TimeZone zone, Locale aLocale)
boolean	equals(Object obj) Suppressed: Compares this calendar to the specified object.
int	get(int field) Enabled: Gets the value for a given time field.
int	getActualMaximum(int field) Enabled: Return the maximum value that this field could have, given the current date.
int	getActualMinimum(int field) Enabled: Return the minimum value that this field could have, given the current date.
static Locale[]	getAvailableLocales() Enabled: Gets the list of locales for which Calendars are installed.
int	getFirstDayOfWeek() Enabled: Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
abstract int	getGreatestMinimum(int field) Enabled: Gets the highest minimum value for the given field if varies.
static Calendar	getInstance() Enabled: Gets a calendar using the default time zone and locale.
static Calendar	getInstance(Locale aLocale) Enabled: Gets a calendar using the default time zone and specified locale.
static Calendar	getInstance(TimeZone zone) Enabled: Gets a calendar using the specified time zone and default locale.
static Calendar	getInstance(TimeZone zone, Locale aLocale) Enabled: Gets a calendar with the specified time zone and locale.
abstract int	getLeastMaximum(int field) Enabled: Gets the lowest maximum value for the given field if varies.
abstract int	getMaximum(int field) Enabled: Gets the maximum value for the given time field.
int	getMinimalDaysInFirstWeek() Enabled: Gets what the minimal days required in the first week of the year are; e.g., if the first week is defined as one that contains the first day of the first month of a year, getMinimalDaysInFirstWeek returns 1.
abstract int	getMinimum(int field) Enabled: Gets the minimum value for the given time field.
Date	getTime() Enabled: Gets this Calendar's current time.
long	getTimeInMillis() Enabled: Gets this Calendar's current time as a long.
TimeZone	getTimeZone() Enabled: Gets the time zone.
int	hashCode() Suppressed: Returns a hash code for this calendar.
protected int	internalGet(int field) Gets the value for a given time field.
(package private) void	internalSet(int field, int value) Sets the value for the given time field.
private void	invalidateWeekFields() Invalidates the WEEK_OF_MONTH and WEEK_OF_YEAR fields if they have been calculated internally.
boolean	isLenient() Enabled: Tell whether date/time interpretation is to be lenient.
boolean	isSet(int field) Enabled: Determines if the given time field has a value set.
private void	readObject(ObjectInputStream stream) Reconstitute this object from a stream (i.e., deserialize it).
abstract void	roll(int field, boolean up) Enabled: Time Field Rolling function.
void	roll(int field, int amount) Enabled: Time Field Rolling function.
void	set(int field, int value) Enabled: Sets the time field with the given value.
void	set(int year, int month, int date) Enabled: Sets the values for the fields year, month, and date.
void	set(int year, int month, int date, int hour, int minute) Enabled: Sets the values for the fields year, month, date, hour, and minute.
void	set(int year, int month, int date, int hour, int minute, int second) Enabled: Sets the values for the fields year, month, date, hour, minute, and second.
void	setFirstDayOfWeek(int value) Enabled: Sets what the first day of the week is; e.g., Sunday in US, Monday in France.
void	setLenient(boolean lenient) Enabled: Specify whether or not date/time interpretation is to be lenient.
void	setMinimalDaysInFirstWeek(int value) Enabled: Sets what the minimal days required in the first week of the year are; For example, if the first week is defined as one that contains the first day of the first month of a year, call the method with value 1.
void	setTime(Date date) Enabled: Sets this Calendar's current time with the given Date.
void	setTimeInMillis(long millis) Enabled: Sets this Calendar's current time from the given long value.
void	setTimeZone(TimeZone value) Enabled: Sets the time zone with the given time zone value.
private void	setWeekCountData(Locale desiredLocale) Both firstDayOfWeek and minimalDaysInFirstWeek are locale-dependent.
String	toString() Suppressed: Return a string representation of this calendar.
private void	updateTime() Recompute the time and update the status fields isTimeSet and areFieldsSet.
private void	writeObject(ObjectOutputStream stream) Save the state of this object to a stream (i.e., serialize it).

Methods inherited from class java.lang.Object

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

Field Detail

ERA

public static final int ERA

Enabled: Field number for get and set indicating the era, e.g., AD or BC in the Julian calendar. This is a calendar-specific value; see subclass documentation.

See Also:

GregorianCalendar.AD, GregorianCalendar.BC

YEAR

public static final int YEAR

Enabled: Field number for get and set indicating the year. This is a calendar-specific value; see subclass documentation.

MONTH

public static final int MONTH

Enabled: Field number for get and set indicating the month. This is a calendar-specific value. The first month of the year is JANUARY which is 0; the last depends on the number of months in a year.

See Also:

JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER, UNDECIMBER

WEEK_OF_YEAR

public static final int WEEK_OF_YEAR

Enabled: Field number for get and set indicating the week number within the current year. The first week of the year, as defined by getFirstDayOfWeek() and getMinimalDaysInFirstWeek(), has value 1. Subclasses define the value of WEEK_OF_YEAR for days before the first week of the year.

See Also:

getFirstDayOfWeek(), getMinimalDaysInFirstWeek()

WEEK_OF_MONTH

public static final int WEEK_OF_MONTH

Enabled: Field number for get and set indicating the week number within the current month. The first week of the month, as defined by getFirstDayOfWeek() and getMinimalDaysInFirstWeek(), has value 1. Subclasses define the value of WEEK_OF_MONTH for days before the first week of the month.

See Also:

getFirstDayOfWeek(), getMinimalDaysInFirstWeek()

DATE

public static final int DATE

Enabled: Field number for get and set indicating the day of the month. This is a synonym for DAY_OF_MONTH. The first day of the month has value 1.

See Also:

DAY_OF_MONTH

DAY_OF_MONTH

public static final int DAY_OF_MONTH

Enabled: Field number for get and set indicating the day of the month. This is a synonym for DATE. The first day of the month has value 1.

See Also:

DATE

DAY_OF_YEAR

public static final int DAY_OF_YEAR

Enabled: Field number for get and set indicating the day number within the current year. The first day of the year has value 1.

DAY_OF_WEEK

public static final int DAY_OF_WEEK

Enabled: Field number for get and set indicating the day of the week. This field takes values SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY.

See Also:

SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY

DAY_OF_WEEK_IN_MONTH

public static final int DAY_OF_WEEK_IN_MONTH

Enabled: Field number for get and set indicating the ordinal number of the day of the week within the current month. Together with the DAY_OF_WEEK field, this uniquely specifies a day within a month. Unlike WEEK_OF_MONTH and WEEK_OF_YEAR, this field's value does not depend on getFirstDayOfWeek() or getMinimalDaysInFirstWeek(). DAY_OF_MONTH 1 through 7 always correspond to DAY_OF_WEEK_IN_MONTH 1; 8 through 14 correspond to DAY_OF_WEEK_IN_MONTH 2, and so on. DAY_OF_WEEK_IN_MONTH 0 indicates the week before DAY_OF_WEEK_IN_MONTH 1. Negative values count back from the end of the month, so the last Sunday of a month is specified as DAY_OF_WEEK = SUNDAY, DAY_OF_WEEK_IN_MONTH = -1. Because negative values count backward they will usually be aligned differently within the month than positive values. For example, if a month has 31 days, DAY_OF_WEEK_IN_MONTH -1 will overlap DAY_OF_WEEK_IN_MONTH 5 and the end of 4.

See Also:

DAY_OF_WEEK, WEEK_OF_MONTH

AM_PM

public static final int AM_PM

Enabled: Field number for get and set indicating whether the HOUR is before or after noon. E.g., at 10:04:15.250 PM the AM_PM is PM.

See Also:

AM, PM, HOUR

HOUR

public static final int HOUR

Enabled: Field number for get and set indicating the hour of the morning or afternoon. HOUR is used for the 12-hour clock. E.g., at 10:04:15.250 PM the HOUR is 10.

See Also:

AM_PM, HOUR_OF_DAY

HOUR_OF_DAY

public static final int HOUR_OF_DAY

Enabled: Field number for get and set indicating the hour of the day. HOUR_OF_DAY is used for the 24-hour clock. E.g., at 10:04:15.250 PM the HOUR_OF_DAY is 22.

See Also:

HOUR

MINUTE

public static final int MINUTE

Enabled: Field number for get and set indicating the minute within the hour. E.g., at 10:04:15.250 PM the MINUTE is 4.

SECOND

public static final int SECOND

Enabled: Field number for get and set indicating the second within the minute. E.g., at 10:04:15.250 PM the SECOND is 15.

MILLISECOND

public static final int MILLISECOND

Enabled: Field number for get and set indicating the millisecond within the second. E.g., at 10:04:15.250 PM the MILLISECOND is 250.

ZONE_OFFSET

public static final int ZONE_OFFSET

Enabled: Field number for get and set indicating the raw offset from GMT in milliseconds.

This field reflects the correct GMT offset value of the time zone of this Calendar if the TimeZone implementation subclass supports historical GMT offset changes.

DST_OFFSET

public static final int DST_OFFSET

Enabled: Field number for get and set indicating the daylight savings offset in milliseconds.

This field reflects the correct daylight saving offset value of the time zone of this Calendar if the TimeZone implementation subclass supports historical Daylight Saving Time schedule changes.

FIELD_COUNT

public static final int FIELD_COUNT

Enabled: The number of distinct fields recognized by get and set. Field numbers range from 0..FIELD_COUNT-1.

SUNDAY

public static final int SUNDAY

Enabled: Value of the DAY_OF_WEEK field indicating Sunday.

MONDAY

public static final int MONDAY

Enabled: Value of the DAY_OF_WEEK field indicating Monday.

TUESDAY

public static final int TUESDAY

Enabled: Value of the DAY_OF_WEEK field indicating Tuesday.

WEDNESDAY

public static final int WEDNESDAY

Enabled: Value of the DAY_OF_WEEK field indicating Wednesday.

THURSDAY

public static final int THURSDAY

Enabled: Value of the DAY_OF_WEEK field indicating Thursday.

FRIDAY

public static final int FRIDAY

Enabled: Value of the DAY_OF_WEEK field indicating Friday.

SATURDAY

public static final int SATURDAY

Enabled: Value of the DAY_OF_WEEK field indicating Saturday.

JANUARY

public static final int JANUARY

Enabled: Value of the MONTH field indicating the first month of the year.

FEBRUARY

public static final int FEBRUARY

Enabled: Value of the MONTH field indicating the second month of the year.

MARCH

public static final int MARCH

Enabled: Value of the MONTH field indicating the third month of the year.

APRIL

public static final int APRIL

Enabled: Value of the MONTH field indicating the fourth month of the year.

MAY

public static final int MAY

Enabled: Value of the MONTH field indicating the fifth month of the year.

JUNE

public static final int JUNE

Enabled: Value of the MONTH field indicating the sixth month of the year.

JULY

public static final int JULY

Enabled: Value of the MONTH field indicating the seventh month of the year.

AUGUST

public static final int AUGUST

Enabled: Value of the MONTH field indicating the eighth month of the year.

SEPTEMBER

public static final int SEPTEMBER

Enabled: Value of the MONTH field indicating the ninth month of the year.

OCTOBER

public static final int OCTOBER

Enabled: Value of the MONTH field indicating the tenth month of the year.

NOVEMBER

public static final int NOVEMBER

Enabled: Value of the MONTH field indicating the eleventh month of the year.

DECEMBER

public static final int DECEMBER

Enabled: Value of the MONTH field indicating the twelfth month of the year.

UNDECIMBER

public static final int UNDECIMBER

Enabled: Value of the MONTH field indicating the thirteenth month of the year. Although GregorianCalendar does not use this value, lunar calendars do.

AM

public static final int AM

Enabled: Value of the AM_PM field indicating the period of the day from midnight to just before noon.

PM

public static final int PM

Enabled: Value of the AM_PM field indicating the period of the day from noon to just before midnight.

fields

protected int[] fields

The field values for the currently set time for this calendar. This is an array of FIELD_COUNT integers, with index values ERA through DST_OFFSET.

isSet

protected boolean[] isSet

The flags which tell if a specified time field for the calendar is set. A new object has no fields set. After the first call to a method which generates the fields, they all remain set after that. This is an array of FIELD_COUNT booleans, with index values ERA through DST_OFFSET.

stamp

transient int[] stamp

Pseudo-time-stamps which specify when each field was set. There are two special values, UNSET and INTERNALLY_SET. Values from MINIMUM_USER_SET to Integer.MAX_VALUE are legal user set values.

time

protected long time

The currently set time for this calendar, expressed in milliseconds after January 1, 1970, 0:00:00 GMT.

See Also:

isTimeSet

isTimeSet

protected boolean isTimeSet

True if then the value of time is valid. The time is made invalid by a change to an item of field[].

See Also:

time

areFieldsSet

protected boolean areFieldsSet

True if fields[] are in sync with the currently set time. If false, then the next attempt to get the value of a field will force a recomputation of all fields from the current value of time.

areAllFieldsSet

transient boolean areAllFieldsSet

True if all fields have been set.

lenient

private boolean lenient

True if this calendar allows out-of-range field values during computation of time from fields[].

See Also:

setLenient(boolean)

zone

private TimeZone zone

The TimeZone used by this calendar. Calendar uses the time zone data to translate between locale and GMT time.

firstDayOfWeek

private int firstDayOfWeek

The first day of the week, with possible values SUNDAY, MONDAY, etc. This is a locale-dependent value.

minimalDaysInFirstWeek

private int minimalDaysInFirstWeek

The number of days required for the first week in a month or year, with possible values from 1 to 7. This is a locale-dependent value.

cachedLocaleData

private static Hashtable cachedLocaleData

Cache to hold the firstDayOfWeek and minimalDaysInFirstWeek of a Locale.

UNSET

static final int UNSET

INTERNALLY_SET

static final int INTERNALLY_SET

MINIMUM_USER_STAMP

static final int MINIMUM_USER_STAMP

nextStamp

private int nextStamp

The next available value for stamp[], an internal array. This actually should not be written out to the stream, and will probably be removed from the stream in the near future. In the meantime, a value of MINIMUM_USER_STAMP should be used.

currentSerialVersion

static final int currentSerialVersion

serialVersionOnStream

private int serialVersionOnStream

The version of the serialized data on the stream. Possible values:

0 or not present on stream

JDK 1.1.5 or earlier.

1

JDK 1.1.6 or later. Writes a correct 'time' value as well as compatible values for other fields. This is a transitional format.

When streaming out this class, the most recent format and the highest allowable serialVersionOnStream is written.

Since:

JDK1.1.6

serialVersionUID

static final long serialVersionUID

FIELD_NAME

private static final String[] FIELD_NAME

Constructor Detail

Calendar

protected Calendar()

Constructs a Calendar with the default time zone and locale.

See Also:

TimeZone.getDefault()

Calendar

protected Calendar(TimeZone zone,
                   Locale aLocale)

Constructs a calendar with the specified time zone and locale.

Parameters:

zone - the time zone to use

aLocale - the locale for the week data

Method Detail

getInstance

public static Calendar getInstance()

Enabled: Gets a calendar using the default time zone and locale. The Calendar returned is based on the current time in the default time zone with the default locale.

Returns:

a Calendar.

getInstance

public static Calendar getInstance(TimeZone zone)

Enabled: Gets a calendar using the specified time zone and default locale. The Calendar returned is based on the current time in the given time zone with the default locale.

Parameters:

zone - the time zone to use

Returns:

a Calendar.

getInstance

public static Calendar getInstance(Locale aLocale)

Enabled: Gets a calendar using the default time zone and specified locale. The Calendar returned is based on the current time in the default time zone with the given locale.

Parameters:

aLocale - the locale for the week data

Returns:

a Calendar.

getInstance

public static Calendar getInstance(TimeZone zone,
                                   Locale aLocale)

Enabled: Gets a calendar with the specified time zone and locale. The Calendar returned is based on the current time in the given time zone with the given locale.

Parameters:

zone - the time zone to use

aLocale - the locale for the week data

Returns:

a Calendar.

createCalendar

private static Calendar createCalendar(TimeZone zone,
                                       Locale aLocale)

getAvailableLocales

public static Locale[] getAvailableLocales()

Enabled: Gets the list of locales for which Calendars are installed.

Returns:

the list of locales for which Calendars are installed.

computeTime

protected abstract void computeTime()

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

computeFields

protected abstract void computeFields()

Converts the current millisecond time value time to field values in fields[]. This allows you to sync up the time field values with a new time that is set for the calendar. The time is not recomputed first; to recompute the time, then the fields, call the complete method.

See Also:

complete()

getTime

public final Date getTime()

Enabled: Gets this Calendar's current time.

Returns:

the current time.

See Also:

setTime(java.util.Date), getTimeInMillis()

setTime

public final void setTime(Date date)

Enabled: Sets this Calendar's current time with the given Date.

Note: Calling setTime() with Date(Long.MAX_VALUE) or Date(Long.MIN_VALUE) may yield incorrect field values from get().

Parameters:

date - the given Date.

See Also:

getTime(), setTimeInMillis(long)

getTimeInMillis

public long getTimeInMillis()

Enabled: Gets this Calendar's current time as a long.

Returns:

the current time as UTC milliseconds from the epoch.

See Also:

getTime(), setTimeInMillis(long)

setTimeInMillis

public void setTimeInMillis(long millis)

Enabled: Sets this Calendar's current time from the given long value.

Parameters:

millis - the new time in UTC milliseconds from the epoch.

See Also:

setTime(java.util.Date), getTimeInMillis()

get

public int get(int field)

Enabled: Gets the value for a given time field.

Parameters:

field - the given time field.

Returns:

the value for the given time field.

Throws:

ArrayIndexOutOfBoundsException - if specified field is out of range (field < 0 || field >= FIELD_COUNT).

internalGet

protected final int internalGet(int field)

Gets the value for a given time field. This is an internal fast time field value getter for the subclasses.

Parameters:

field - the given time field.

Returns:

the value for the given time field.

internalSet

final void internalSet(int field,
                       int value)

Sets the value for the given time field. This is an internal fast setter for subclasses. It does not affect the areFieldsSet, isTimeSet, or areAllFieldsSet flags.

set

public void set(int field,
                int value)

Enabled: Sets the time field with the given value.

Parameters:

field - the given time field.

value - the value to be set for the given time field.

Throws:

ArrayIndexOutOfBoundsException - if specified field is out of range (field < 0 || field >= FIELD_COUNT).

set

public final void set(int year,
                      int month,
                      int date)

Enabled: Sets the values for the fields year, month, and date. Previous values of other fields are retained. If this is not desired, call clear first.

Parameters:

year - the value used to set the YEAR time field.

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

date - the value used to set the DATE time field.

set

public final void set(int year,
                      int month,
                      int date,
                      int hour,
                      int minute)

Enabled: Sets the values for the fields year, month, date, hour, and minute. Previous values of other fields are retained. If this is not desired, call clear first.

Parameters:

year - the value used to set the YEAR time field.

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

date - the value used to set the DATE time field.

hour - the value used to set the HOUR_OF_DAY time field.

minute - the value used to set the MINUTE time field.

set

public final void set(int year,
                      int month,
                      int date,
                      int hour,
                      int minute,
                      int second)

Enabled: Sets the values for the fields year, month, date, hour, minute, and second. Previous values of other fields are retained. If this is not desired, call clear first.

Parameters:

year - the value used to set the YEAR time field.

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

date - the value used to set the DATE time field.

hour - the value used to set the HOUR_OF_DAY time field.

minute - the value used to set the MINUTE time field.

second - the value used to set the SECOND time field.

clear

public final void clear()

Enabled: Clears the values of all the time fields.

clear

public final void clear(int field)

Enabled: Clears the value in the given time field.

Parameters:

field - the time field to be cleared.

isSet

public final boolean isSet(int field)

Enabled: Determines if the given time field has a value set.

Returns:

true if the given time field has a value set; false otherwise.

complete

protected void complete()

Fills in any unset fields in the time field list.

equals

public boolean equals(Object obj)

Suppressed: Compares this calendar to the specified object. The result is true if and only if the argument is not null and is a Calendar object that represents the same calendar as this object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

See Also:

Object.hashCode(), java.util.Hashtable

hashCode

public int hashCode()

Suppressed: Returns a hash code for this calendar.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

Since:

1.2

See Also:

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

before

public boolean before(Object when)

Enabled: Compares the time field records. Equivalent to comparing result of conversion to UTC.

Parameters:

when - the Calendar to be compared with this Calendar.

Returns:

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

after

public boolean after(Object when)

Enabled: Compares the time field records. Equivalent to comparing result of conversion to UTC.

Parameters:

when - the Calendar to be compared with this Calendar.

Returns:

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

add

public abstract void add(int field,
                         int amount)

Enabled: Date Arithmetic function. Adds the specified (signed) amount of time to the given time field, based on the calendar's rules. For example, to subtract 5 days from the current time of the calendar, you can achieve it by calling:

add(Calendar.DATE, -5).

Parameters:

field - the time field.

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

roll

public abstract void roll(int field,
                          boolean up)

Enabled: Time Field Rolling function. Adds or subtracts (up/down) a single unit of time on the given time field without changing larger fields. For example, to roll the current date up by one day, you can achieve it by calling:

roll(Calendar.DATE, true). When rolling on the year or Calendar.YEAR field, it will roll the year value in the range between 1 and the value returned by calling getMaximum(Calendar.YEAR). When rolling on the month or Calendar.MONTH field, other fields like date might conflict and, need to be changed. For instance, rolling the month on the date 01/31/96 will result in 02/29/96. When rolling on the hour-in-day or Calendar.HOUR_OF_DAY field, it will roll the hour value in the range between 0 and 23, which is zero-based.

Parameters:

field - the time field.

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

See Also:

add(int, int), set(int, int)

roll

public void roll(int field,
                 int amount)

Enabled: Time Field Rolling function. Add to field a signed amount without changing larger fields. A negative roll amount means to roll down. [NOTE: This default implementation on Calendar just repeatedly calls the version of roll() that takes a boolean and rolls by one unit. This may not always do the right thing. For example, if the DAY_OF_MONTH field is 31, rolling through February will leave it set to 28. The GregorianCalendar version of this function takes care of this problem. Other subclasses should also provide overrides of this function that do the right thing.

Parameters:

field - the time field.

amount - the signed amount to add to field.

Since:

1.2

See Also:

add(int, int), set(int, int)

setTimeZone

public void setTimeZone(TimeZone value)

Enabled: Sets the time zone with the given time zone value.

Parameters:

value - the given time zone.

getTimeZone

public TimeZone getTimeZone()

Enabled: Gets the time zone.

Returns:

the time zone object associated with this calendar.

setLenient

public void setLenient(boolean lenient)

Enabled: Specify whether or not date/time interpretation is to be lenient. With lenient interpretation, a date such as "February 942, 1996" will be treated as being equivalent to the 941st day after February 1, 1996. With strict interpretation, such dates will cause an exception to be thrown.

See Also:

java.text.DateFormat#setLenient

isLenient

public boolean isLenient()

Enabled: Tell whether date/time interpretation is to be lenient.

setFirstDayOfWeek

public void setFirstDayOfWeek(int value)

Enabled: Sets what the first day of the week is; e.g., Sunday in US, Monday in France.

Parameters:

value - the given first day of the week.

getFirstDayOfWeek

public int getFirstDayOfWeek()

Enabled: Gets what the first day of the week is; e.g., Sunday in US, Monday in France.

Returns:

the first day of the week.

setMinimalDaysInFirstWeek

public void setMinimalDaysInFirstWeek(int value)

Enabled: Sets what the minimal days required in the first week of the year are; For example, if the first week is defined as one that contains the first day of the first month of a year, call the method with value 1. If it must be a full week, use value 7.

Parameters:

value - the given minimal days required in the first week of the year.

getMinimalDaysInFirstWeek

public int getMinimalDaysInFirstWeek()

Enabled: Gets what the minimal days required in the first week of the year are; e.g., if the first week is defined as one that contains the first day of the first month of a year, getMinimalDaysInFirstWeek returns 1. If the minimal days required must be a full week, getMinimalDaysInFirstWeek returns 7.

Returns:

the minimal days required in the first week of the year.

getMinimum

public abstract int getMinimum(int field)

Enabled: Gets the minimum value for the given time field. e.g., for Gregorian DAY_OF_MONTH, 1.

Parameters:

field - the given time field.

Returns:

the minimum value for the given time field.

getMaximum

public abstract int getMaximum(int field)

Enabled: Gets the maximum value for the given time field. e.g. for Gregorian DAY_OF_MONTH, 31.

Parameters:

field - the given time field.

Returns:

the maximum value for the given time field.

getGreatestMinimum

public abstract int getGreatestMinimum(int field)

Enabled: Gets the highest minimum value for the given field if varies. Otherwise same as getMinimum(). For Gregorian, no difference.

Parameters:

field - the given time field.

Returns:

the highest minimum value for the given time field.

getLeastMaximum

public abstract int getLeastMaximum(int field)

Enabled: Gets the lowest maximum value for the given field if varies. Otherwise same as getMaximum(). e.g., for Gregorian DAY_OF_MONTH, 28.

Parameters:

field - the given time field.

Returns:

the lowest maximum value for the given time field.

getActualMinimum

public int getActualMinimum(int field)

Enabled: Return the minimum value that this field could have, given the current date. For the Gregorian calendar, this is the same as getMinimum() and getGreatestMinimum(). The version of this function on Calendar uses an iterative algorithm to determine the actual minimum value for the field. There is almost always a more efficient way to accomplish this (in most cases, you can simply return getMinimum()). GregorianCalendar overrides this function with a more efficient implementation.

Parameters:

field - the field to determine the minimum of

Returns:

the minimum of the given field for the current date of this Calendar

Since:

1.2

getActualMaximum

public int getActualMaximum(int field)

Enabled: Return the maximum value that this field could have, given the current date. For example, with the date "Feb 3, 1997" and the DAY_OF_MONTH field, the actual maximum would be 28; for "Feb 3, 1996" it s 29. Similarly for a Hebrew calendar, for some years the actual maximum for MONTH is 12, and for others 13. The version of this function on Calendar uses an iterative algorithm to determine the actual maximum value for the field. There is almost always a more efficient way to accomplish this (in most cases, you can simply return getMaximum()). GregorianCalendar overrides this function with a more efficient implementation.

Parameters:

field - the field to determine the maximum of

Returns:

the maximum of the given field for the current date of this Calendar

Since:

1.2

clone

public Object clone()

Suppressed: Overrides Cloneable

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

java.lang.Cloneable

toString

public String toString()

Suppressed: Return a string representation of this calendar. This method is intended to be used only for debugging purposes, and the format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

toString in class Object

Returns:

a string representation of this calendar.

setWeekCountData

private void setWeekCountData(Locale desiredLocale)

Both firstDayOfWeek and minimalDaysInFirstWeek are locale-dependent. They are used to figure out the week count for a specific date for a given locale. These must be set when a Calendar is constructed.

Parameters:

desiredLocale - the given locale.

updateTime

private void updateTime()

Recompute the time and update the status fields isTimeSet and areFieldsSet. Callers should check isTimeSet and only call this method if isTimeSet is false.

adjustStamp

private final void adjustStamp()

Adjusts the stamp[] values before nextStamp overflow. nextStamp is set to the next stamp value upon the return.

invalidateWeekFields

private void invalidateWeekFields()

Invalidates the WEEK_OF_MONTH and WEEK_OF_YEAR fields if they have been calculated internally.

writeObject

private void writeObject(ObjectOutputStream stream)
                  throws IOException

Save the state of this object to a stream (i.e., serialize it). Ideally, Calendar would only write out its state data and the current time, and not write any field data out, such as fields[], isTimeSet, areFieldsSet, and isSet[]. nextStamp also should not be part of the persistent state. Unfortunately, this didn't happen before JDK 1.1 shipped. To be compatible with JDK 1.1, we will always have to write out the field values and state flags. However, nextStamp can be removed from the serialization stream; this will probably happen in the near future.

IOException

readObject

private void readObject(ObjectInputStream stream)
                 throws IOException,
                        ClassNotFoundException

Reconstitute this object from a stream (i.e., deserialize it).

IOException

ClassNotFoundException