java::util::Calendar Class Reference

Inheritance diagram for java::util::Calendar:

Inheritance graph
java::util::GregorianCalendarjava::lang::Object
[legend]
Collaboration diagram for java::util::Calendar:

Collaboration graph
java::lang::Object
[legend]

List of all members.


Detailed Description

Calendar is an abstract base class for converting between a Date object and a set of integer fields such as YEAR, MONTH, DAY, HOUR, and so on.

(A Date object represents a specific instant in time with millisecond precision. See java.util.Date for information about the Date class.)

Subclasses of Calendar interpret a Date according to the rules of a specific calendar system. The DK provides one concrete subclass of Calendar: GregorianCalendar. Future subclasses could represent the various types of lunar calendars in use in many parts of the world.

Like other locale-sensitive classes, Calendar provides a class method, getInstance, for getting a generally useful object of this type. Calendar's getInstance method returns a GregorianCalendar object whose time fields have been initialized with the current date and time: <blockquote>

 Calendar rightNow = Calendar.getInstance();
 
</blockquote>

A Calendar object can produce all the time field values needed to implement the date-time formatting for a particular language and calendar style (for example, Japanese-Gregorian, Japanese-Traditional).

When computing a Date from time fields, two special circumstances may arise: there may be insufficient information to compute the Date (such as only year and month but no day in the month), or there may be inconsistent information (such as "Tuesday, July 15, 1996" -- July 15, 1996 is actually a Monday).

Insufficient information. The calendar will use default information to specify the missing fields. This may vary by calendar; for the Gregorian calendar, the default for a field is the same as that of the start of the epoch: i.e., YEAR = 1970, MONTH = JANUARY, DATE = 1, etc.

Inconsistent information. If fields conflict, the calendar will give preference to fields set more recently. For example, when determining the day, the calendar will look for one of the following combinations of fields. The most recent combination, as determined by the most recently set single field, will be used.

<blockquote>

 MONTH + DAY_OF_MONTH
 MONTH + WEEK_OF_MONTH + DAY_OF_WEEK
 MONTH + DAY_OF_WEEK_IN_MONTH + DAY_OF_WEEK
 DAY_OF_YEAR
 DAY_OF_WEEK + WEEK_OF_YEAR
 
</blockquote>

For the time of day:

<blockquote>

 HOUR_OF_DAY
 AM_PM + HOUR
 
</blockquote>

Note: for some non-Gregorian calendars, different fields may be necessary for complete disambiguation. For example, a full specification of the historial Arabic astronomical calendar requires year, month, day-of-month and day-of-week in some cases.

Note: There are certain possible ambiguities in interpretation of certain singular times, which are resolved in the following ways:

  1. 24:00:00 "belongs" to the following day. That is, 23:59 on Dec 31, 1969 < 24:00 on Jan 1, 1970 < 24:01:00 on Jan 1, 1970

  2. Although historically not precise, midnight also belongs to "am", and noon belongs to "pm", so on the same day, 12:00 am (midnight) < 12:01 am, and 12:00 pm (noon) < 12:01 pm

The date or time format strings are not part of the definition of a calendar, as those must be modifiable or overridable by the user at runtime. Use java.text.DateFormat to format dates.

Calendar provides an API for field "rolling", where fields can be incremented or decremented, but wrap around. For example, rolling the month up in the date "September 12, 1996" results in "October 12, 1996".

Calendar also provides a date arithmetic function for adding the specified (signed) amount of time to a particular time field. For example, subtracting 5 days from the date "September 12, 1996" results in "September 7, 1996".

See also:
Date

GregorianCalendar

TimeZone

Version:
1.17 06 Jan 1997
Author:
Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu

Public Types

enum  FIELDS {
  ERA = 0, YEAR, MONTH, WEEK_OF_YEAR,
  WEEK_OF_MONTH, DATE, DAY_OF_MONTH = DATE, DAY_OF_YEAR,
  DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, AM_PM, HOUR,
  HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND,
  ZONE_OFFSET, DST_OFFSET, FIELD_COUNT
}
enum  DAYS {
  SUNDAY = 1, MONDAY, TUESDAY, WEDNESDAY,
  THURSDAY, FRIDAY, SATURDAY
}
enum  MONTHS {
  JANUARY = 0, FEBRUARY, MARCH, APRIL,
  MAY, UNE, ULY, AUGUST,
  SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER,
  UNDECIMBER
}
enum  HALF_DAY { AM = 0, PM }

Public Member Functions

Date getTime () const
 Gets this Calendar's current time.
void setTime (const Date &date)
 Sets this Calendar's current time with the given Date.
jint get (jint field) const
 Gets the value for a given time field.
void set (jint field, jint value)
 Sets the time field with the given value.
void set (jint year, jint month, jint date)
 Sets the values for the fields year, month, and date.
void set (jint year, jint month, jint date, jint hour, jint minute)
 Sets the values for the fields year, month, date, hour, and minute.
void set (jint year, jint month, jint date, jint hour, jint minute, jint second)
 Sets the values for the fields year, month, date, hour, minute, and second.
void clear ()
 Clears the values of all the time fields.
void clear (jint field)
 Clears the value in the given time field.
jboolean isSet (jint field) const
 Determines if the given time field has a value set.
virtual jboolean equals (const Object &obj) const
 Compares this calendar to the specified object.
virtual jint hashCode () const
 Returns a hash code for this calendar.
virtual jboolean before (const Calendar &when) const
 Compares the time field records.
virtual jboolean after (const Calendar &when) const
 Compares the time field records.
virtual void add (jint field, jint amount)=0
 Date Arithmetic function.
virtual void roll (jint field, jboolean up)=0
 Time Field Rolling function.
virtual void roll (jint field, jint amount)
 Time Field Rolling function.
virtual void setTimeZone (const TimeZone &value)
 Sets the time zone with the given time zone value.
virtual TimeZonegetTimeZone () const
 Gets the time zone.
virtual void setLenient (jboolean lenient)
 Specify whether or not date/time interpretation is to be lenient.
virtual jboolean isLenient () const
 Tell whether date/time interpretation is to be lenient.
virtual void setFirstDayOfWeek (jint value)
 Sets what the first day of the week is; e.g., Sunday in US, Monday in France.
virtual jint getFirstDayOfWeek () const
 Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
virtual void setMinimalDaysInFirstWeek (jint value)
 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.
virtual jint getMinimalDaysInFirstWeek () const
 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.
virtual jint getMinimum (jint field) const =0
 Gets the minimum value for the given time field.
virtual jint getMaximum (jint field) const =0
 Gets the maximum value for the given time field.
virtual jint getGreatestMinimum (jint field) const =0
 Gets the highest minimum value for the given field if varies.
virtual jint getLeastMaximum (jint field) const =0
 Gets the lowest maximum value for the given field if varies.
virtual jint getActualMinimum (jint field) const
 Return the minimum value that this field could have, given the current date.
virtual jint getActualMaximum (jint field) const
 Return the maximum value that this field could have, given the current date.
virtual jboolean inDaylightTime () const =0
 Return true if the current time for this Calendar is in Daylignt Savings Time.
virtual String toString () const
 Return a string representation of this calendar.

Static Public Member Functions

static Ref< CalendargetInstance ()
 Gets a calendar using the default time zone and.
static Ref< CalendargetInstance (const TimeZone &zone)
 Gets a calendar using the specified time zone.

Protected Types

enum  STAMPS { UNSET, INTERNALLY_SET, MINIMUM_USER_STAMP }

Protected Member Functions

virtual void computeTime ()=0
 Converts the current field values in fields[] to the millisecond time value time.
virtual void computeFields ()=0
 Converts the current millisecond time value time to field values in fields[].
virtual jlong getTimeInMillis () const
 Gets this Calendar's current time as a long.
virtual void setTimeInMillis (jlong millis)
 Sets this Calendar's current time from the given long value.
jint internalGet (jint field) const
 Gets the value for a given time field.
void internalSet (jint field, jint value)
 Sets the value for the given time field.
void complete ()
 Fills in any unset fields in the time field list.
 Calendar ()
 Constructs a Calendar with the default time zone.
 Calendar (const TimeZone &zone)
 Constructs a calendar with the specified time zone and locale.

Protected Attributes

jint fields [FIELD_COUNT]
 The field values for the currently set time for this calendar.
jint stamp [FIELD_COUNT]
 Pseudo-time-stamps which specify when each field was set.
jlong time
 The currently set time for this calendar, expressed in milliseconds after January 1, 1970, 0:00:00 GMT.
jboolean isTimeSet
 True if then the value of time is valid.
jboolean areFieldsSet
 True if fields[] are in sync with the currently set time.
jboolean areAllFieldsSet
 True if fields[] are in sync with the currently set time.

Member Enumeration Documentation

enum java::util::Calendar::FIELDS

Enumerator:
ERA  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  Field number for get and set indicating the year.

This is a calendar-specific value; see subclass documentation.

MONTH  Field number for get and set indicating the month.

This is a calendar-specific value. The first month of the year is JANUARY; the last depends on the number of months in a year.

See also:
JANUARY

FEBRUARY

MARCH

APRIL

MAY

UNE

ULY

AUGUST

SEPTEMBER

OCTOBER

NOVEMBER

DECEMBER

UNDECIMBER

WEEK_OF_YEAR  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  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  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  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  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  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  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 15 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  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  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  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  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  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  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  Field number for get and set indicating the raw offset from GMT in milliseconds.
DST_OFFSET  Field number for get and set indicating the daylight savings offset in milliseconds.
FIELD_COUNT  The number of distict fields recognized by get and set.

Field numbers range from 0..FIELD_COUNT-1.

enum java::util::Calendar::DAYS

Enumerator:
SUNDAY  Value of the DAY_OF_WEEK field indicating Sunday.
MONDAY  Value of the DAY_OF_WEEK field indicating Monday.
TUESDAY  Value of the DAY_OF_WEEK field indicating Tuesday.
WEDNESDAY  Value of the DAY_OF_WEEK field indicating Wednesday.
THURSDAY  Value of the DAY_OF_WEEK field indicating Tuesday.
FRIDAY  Value of the DAY_OF_WEEK field indicating Friday.
SATURDAY  Value of the DAY_OF_WEEK field indicating Saturday.

enum java::util::Calendar::MONTHS

Enumerator:
JANUARY  Value of the MONTH field indicating the first month of the year.
FEBRUARY  Value of the MONTH field indicating the second month of the year.
MARCH  Value of the MONTH field indicating the third month of the year.
APRIL  Value of the MONTH field indicating the fourth month of the year.
MAY  Value of the MONTH field indicating the fifth month of the year.
UNE  Value of the MONTH field indicating the sixth month of the year.
ULY  Value of the MONTH field indicating the seventh month of the year.
AUGUST  Value of the MONTH field indicating the eighth month of the year.
SEPTEMBER  Value of the MONTH field indicating the ninth month of the year.
OCTOBER  Value of the MONTH field indicating the tenth month of the year.
NOVEMBER  Value of the MONTH field indicating the eleventh month of the year.
DECEMBER  Value of the MONTH field indicating the twelfth month of the year.
UNDECIMBER  Value of the MONTH field indicating the thirteenth month of the year.

Although GregorianCalendar does not use this value, lunar calendars do.

enum java::util::Calendar::HALF_DAY

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

enum java::util::Calendar::STAMPS [protected]

Enumerator:
UNSET 
INTERNALLY_SET 
MINIMUM_USER_STAMP 


Constructor & Destructor Documentation

java::util::Calendar::Calendar (  )  [protected]

Constructs a Calendar with the default time zone.

See also:
TimeZone::getDefault

java::util::Calendar::Calendar ( const TimeZone zone  )  [protected]

Constructs a calendar with the specified time zone and locale.

Parameters:
zone the time zone to use


Member Function Documentation

static Ref<Calendar> java::util::Calendar::getInstance (  )  [static]

Gets a calendar using the default time zone and.

Returns:
a Calendar.

static Ref<Calendar> java::util::Calendar::getInstance ( const TimeZone zone  )  [static]

Gets a calendar using the specified time zone.

Parameters:
zone the time zone to use
Returns:
a Calendar.

Date java::util::Calendar::getTime (  )  const

Gets this Calendar's current time.

Returns:
the current time.

void java::util::Calendar::setTime ( const Date date  ) 

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.

jint java::util::Calendar::get ( jint  field  )  const

Gets the value for a given time field.

Parameters:
field the given time field.
Returns:
the value for the given time field.

void java::util::Calendar::set ( jint  field,
jint  value 
)

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.

void java::util::Calendar::set ( jint  year,
jint  month,
jint  date 
)

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.

void java::util::Calendar::set ( jint  year,
jint  month,
jint  date,
jint  hour,
jint  minute 
)

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.

void java::util::Calendar::set ( jint  year,
jint  month,
jint  date,
jint  hour,
jint  minute,
jint  second 
)

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.

void java::util::Calendar::clear (  ) 

Clears the values of all the time fields.

void java::util::Calendar::clear ( jint  field  ) 

Clears the value in the given time field.

Parameters:
field the time field to be cleared.

jboolean java::util::Calendar::isSet ( jint  field  )  const

Determines if the given time field has a value set.

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

virtual jboolean java::util::Calendar::equals ( const Object obj  )  const [virtual]

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.

Parameters:
obj the object to compare with.
Returns:
true if the objects are the same; false otherwise.

Reimplemented from java::lang::Object.

Reimplemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::hashCode (  )  const [virtual]

Returns a hash code for this calendar.

Returns:
a hash code value for this object.
Since:
1.2

Reimplemented from java::lang::Object.

Reimplemented in java::util::GregorianCalendar.

virtual jboolean java::util::Calendar::before ( const Calendar when  )  const [virtual]

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.

virtual jboolean java::util::Calendar::after ( const Calendar when  )  const [virtual]

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.

virtual void java::util::Calendar::add ( jint  field,
jint  amount 
) [pure virtual]

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.

Implemented in java::util::GregorianCalendar.

virtual void java::util::Calendar::roll ( jint  field,
jboolean  up 
) [pure virtual]

Time Field Rolling function.

Rolls (up/down) a single unit of time on the given time field. 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.

Implemented in java::util::GregorianCalendar.

virtual void java::util::Calendar::roll ( jint  field,
jint  amount 
) [virtual]

Time Field Rolling function.

Rolls up or down the specified number of units on the given time field. (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.

Since:
1.2

Reimplemented in java::util::GregorianCalendar.

virtual void java::util::Calendar::setTimeZone ( const TimeZone value  )  [virtual]

Sets the time zone with the given time zone value.

Parameters:
value the given time zone.

virtual TimeZone& java::util::Calendar::getTimeZone (  )  const [virtual]

Gets the time zone.

Returns:
the time zone object associated with this calendar.

virtual void java::util::Calendar::setLenient ( jboolean  lenient  )  [virtual]

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

virtual jboolean java::util::Calendar::isLenient (  )  const [virtual]

Tell whether date/time interpretation is to be lenient.

virtual void java::util::Calendar::setFirstDayOfWeek ( jint  value  )  [virtual]

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.

virtual jint java::util::Calendar::getFirstDayOfWeek (  )  const [virtual]

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

Returns:
the first day of the week.

virtual void java::util::Calendar::setMinimalDaysInFirstWeek ( jint  value  )  [virtual]

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.

virtual jint java::util::Calendar::getMinimalDaysInFirstWeek (  )  const [virtual]

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.

virtual jint java::util::Calendar::getMinimum ( jint  field  )  const [pure virtual]

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.

Implemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::getMaximum ( jint  field  )  const [pure virtual]

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.

Implemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::getGreatestMinimum ( jint  field  )  const [pure virtual]

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.

Implemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::getLeastMaximum ( jint  field  )  const [pure virtual]

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.

Implemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::getActualMinimum ( jint  field  )  const [virtual]

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

Reimplemented in java::util::GregorianCalendar.

virtual jint java::util::Calendar::getActualMaximum ( jint  field  )  const [virtual]

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

Reimplemented in java::util::GregorianCalendar.

virtual jboolean java::util::Calendar::inDaylightTime (  )  const [pure virtual]

Return true if the current time for this Calendar is in Daylignt Savings Time.

Implemented in java::util::GregorianCalendar.

virtual String java::util::Calendar::toString (  )  const [virtual]

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.

Returns:
a string representation of this calendar.

Reimplemented from java::lang::Object.

virtual void java::util::Calendar::computeTime (  )  [protected, pure virtual]

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

Implemented in java::util::GregorianCalendar.

virtual void java::util::Calendar::computeFields (  )  [protected, pure virtual]

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

Implemented in java::util::GregorianCalendar.

virtual jlong java::util::Calendar::getTimeInMillis (  )  const [protected, virtual]

Gets this Calendar's current time as a long.

Returns:
the current time as UTC milliseconds from the epoch.

virtual void java::util::Calendar::setTimeInMillis ( jlong  millis  )  [protected, virtual]

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

Parameters:
date the new time in UTC milliseconds from the epoch.

jint java::util::Calendar::internalGet ( jint  field  )  const [protected]

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.

void java::util::Calendar::internalSet ( jint  field,
jint  value 
) [protected]

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.

void java::util::Calendar::complete (  )  [protected]

Fills in any unset fields in the time field list.


Member Data Documentation

jint java::util::Calendar::fields[FIELD_COUNT] [protected]

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.

jint java::util::Calendar::stamp[FIELD_COUNT] [protected]

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.

jlong java::util::Calendar::time [protected]

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

See also:
isTimeSet

jboolean java::util::Calendar::isTimeSet [protected]

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

jboolean java::util::Calendar::areFieldsSet [protected]

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.

jboolean java::util::Calendar::areAllFieldsSet [protected]

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.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:47 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3