Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

Calendar Class Reference

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

#include <calendar.h>

Inheritance diagram for Calendar::

UObject UMemory GregorianCalendar List of all members.

Public Types

enum  EDateFields {
  ERA, YEAR, MONTH, WEEK_OF_YEAR,
  WEEK_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, YEAR_WOY, DOW_LOCAL, FIELD_COUNT = UCAL_FIELD_COUNT
}
 Field IDs for date and time. More...

enum  EDaysOfWeek {
  SUNDAY = 1, MONDAY, TUESDAY, WEDNESDAY,
  THURSDAY, FRIDAY, SATURDAY
}
 Useful constant for days of week. More...

enum  EMonths {
  JANUARY, FEBRUARY, MARCH, APRIL,
  MAY, JUNE, JULY, AUGUST,
  SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER,
  UNDECIMBER
}
 Useful constants for month. More...

enum  EAmpm { AM, PM }
 Useful constants for hour in 12-hour clock. More...


Public Methods

virtual ~Calendar ()
 destructor. More...

virtual Calendar * clone (void) const=0
 Create and return a polymorphic copy of this calendar. More...

UDate getTime (UErrorCode &status) const
 Gets this Calendar's time as milliseconds. More...

void setTime (UDate date, UErrorCode &status)
 Sets this Calendar's current time with the given UDate. More...

virtual UBool operator== (const Calendar &that) const
 Compares the equality of two Calendar objects. More...

UBool operator!= (const Calendar &that) const
 Compares the inequality of two Calendar objects. More...

virtual UBool isEquivalentTo (const Calendar &other) const
 Returns TRUE if the given Calendar object is equivalent to this one. More...

UBool equals (const Calendar &when, UErrorCode &status) const
 Compares the Calendar time, whereas Calendar::operator== compares the equality of Calendar objects. More...

UBool before (const Calendar &when, UErrorCode &status) const
 Returns true if this Calendar's current time is before "when"'s current time. More...

UBool after (const Calendar &when, UErrorCode &status) const
 Returns true if this Calendar's current time is after "when"'s current time. More...

virtual void add (EDateFields field, int32_t amount, UErrorCode &status)
 UDate Arithmetic function. More...

virtual void add (UCalendarDateFields field, int32_t amount, UErrorCode &status)
 UDate Arithmetic function. More...

void roll (EDateFields field, UBool up, UErrorCode &status)
 Time Field Rolling function. More...

void roll (UCalendarDateFields field, UBool up, UErrorCode &status)
 Time Field Rolling function. More...

virtual void roll (EDateFields field, int32_t amount, UErrorCode &status)=0
 Time Field Rolling function. More...

virtual void roll (UCalendarDateFields field, int32_t amount, UErrorCode &status)
 Time Field Rolling function. More...

virtual int32_t fieldDifference (UDate when, EDateFields field, UErrorCode &status)
 Return the difference between the given time and the time this calendar object is set to. More...

virtual int32_t fieldDifference (UDate when, UCalendarDateFields field, UErrorCode &status)
 Return the difference between the given time and the time this calendar object is set to. More...

void adoptTimeZone (TimeZone *value)
 Sets the calendar's time zone to be the one passed in. More...

void setTimeZone (const TimeZone &zone)
 Sets the calendar's time zone to be the same as the one passed in. More...

const TimeZonegetTimeZone (void) const
 Returns a reference to the time zone owned by this calendar. More...

TimeZoneorphanTimeZone (void)
 Returns the time zone owned by this calendar. More...

virtual UBool inDaylightTime (UErrorCode &status) const=0
 Queries if the current date for this Calendar is in Daylight Savings Time. More...

void setLenient (UBool lenient)
 Specifies whether or not date/time interpretation is to be lenient. More...

UBool isLenient (void) const
 Tells whether date/time interpretation is to be lenient. More...

void setFirstDayOfWeek (EDaysOfWeek value)
 Sets what the first day of the week is; e.g., Sunday in US, Monday in France. More...

void setFirstDayOfWeek (UCalendarDaysOfWeek value)
 Sets what the first day of the week is; e.g., Sunday in US, Monday in France. More...

EDaysOfWeek getFirstDayOfWeek (void) const
 Gets what the first day of the week is; e.g., Sunday in US, Monday in France. More...

UCalendarDaysOfWeek getFirstDayOfWeek (UErrorCode &status) const
 Gets what the first day of the week is; e.g., Sunday in US, Monday in France. More...

void setMinimalDaysInFirstWeek (uint8_t 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. More...

uint8_t getMinimalDaysInFirstWeek (void) 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. More...

virtual int32_t getMinimum (EDateFields field) const
 Gets the minimum value for the given time field. More...

virtual int32_t getMinimum (UCalendarDateFields field) const
 Gets the minimum value for the given time field. More...

virtual int32_t getMaximum (EDateFields field) const
 Gets the maximum value for the given time field. More...

virtual int32_t getMaximum (UCalendarDateFields field) const
 Gets the maximum value for the given time field. More...

virtual int32_t getGreatestMinimum (EDateFields field) const
 Gets the highest minimum value for the given field if varies. More...

virtual int32_t getGreatestMinimum (UCalendarDateFields field) const
 Gets the highest minimum value for the given field if varies. More...

virtual int32_t getLeastMaximum (EDateFields field) const
 Gets the lowest maximum value for the given field if varies. More...

virtual int32_t getLeastMaximum (UCalendarDateFields field) const
 Gets the lowest maximum value for the given field if varies. More...

int32_t getActualMinimum (EDateFields field, UErrorCode &status) const
 Return the minimum value that this field could have, given the current date. More...

int32_t getActualMinimum (UCalendarDateFields field, UErrorCode &status) const
 Return the minimum value that this field could have, given the current date. More...

int32_t getActualMaximum (EDateFields field, UErrorCode &status) const
 Return the maximum value that this field could have, given the current date. More...

int32_t getActualMaximum (UCalendarDateFields field, UErrorCode &status) const
 Return the maximum value that this field could have, given the current date. More...

int32_t get (EDateFields field, UErrorCode &status) const
 Gets the value for a given time field. More...

int32_t get (UCalendarDateFields field, UErrorCode &status) const
 Gets the value for a given time field. More...

UBool isSet (EDateFields field) const
 Determines if the given time field has a value set. More...

UBool isSet (UCalendarDateFields field) const
 Determines if the given time field has a value set. More...

void set (EDateFields field, int32_t value)
 Sets the given time field with the given value. More...

void set (UCalendarDateFields field, int32_t value)
 Sets the given time field with the given value. More...

void set (int32_t year, int32_t month, int32_t date)
 Sets the values for the fields YEAR, MONTH, and DATE. More...

void set (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute)
 Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, and MINUTE. More...

void set (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second)
 Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, MINUTE, and SECOND. More...

void clear (void)
 Clears the values of all the time fields, making them both unset and assigning them a value of zero. More...

void clear (EDateFields field)
 Clears the value in the given time field, both making it unset and assigning it a value of zero. More...

void clear (UCalendarDateFields field)
 Clears the value in the given time field, both making it unset and assigning it a value of zero. More...

virtual UClassID getDynamicClassID (void) const=0
 Returns a unique class ID POLYMORPHICALLY. More...

virtual const char * getType () const=0
 Returns the resource key string used for this calendar type. More...

virtual UBool haveDefaultCentury () const=0
virtual UDate defaultCenturyStart () const=0
virtual int32_t defaultCenturyStartYear () const=0
virtual Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this calendar object. More...

virtual const char * getLocaleInternal (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this calendar object. More...


Static Public Methods

Calendar * createInstance (UErrorCode &success)
 Creates a Calendar using the default timezone and locale. More...

Calendar * createInstance (TimeZone *zoneToAdopt, UErrorCode &success)
 Creates a Calendar using the given timezone and the default locale. More...

Calendar * createInstance (const TimeZone &zone, UErrorCode &success)
 Creates a Calendar using the given timezone and the default locale. More...

Calendar * createInstance (const Locale &aLocale, UErrorCode &success)
 Creates a Calendar using the default timezone and the given locale. More...

Calendar * createInstance (TimeZone *zoneToAdopt, const Locale &aLocale, UErrorCode &success)
 Creates a Calendar using the given timezone and given locale. More...

Calendar * createInstance (const TimeZone &zoneToAdopt, const Locale &aLocale, UErrorCode &success)
 Gets a Calendar using the given timezone and given locale. More...

const LocalegetAvailableLocales (int32_t &count)
 Returns a list of the locales for which Calendars are installed. More...

UDate getNow (void)
 Returns the current UTC (GMT) time measured in milliseconds since 0:00:00 on 1/1/70 (derived from the system time). More...

StringEnumerationgetAvailableLocales (void)
 Return a StringEnumeration over the locales available at the time of the call, including registered locales. More...

URegistryKey registerFactory (ICUServiceFactory *toAdopt, UErrorCode &status)
 Register a new Calendar factory. More...

UBool unregister (URegistryKey key, UErrorCode &status)
 Unregister a previously-registered CalendarFactory using the key returned from the register call. More...


Protected Types

enum  ELimitType {
  UCAL_LIMIT_MINIMUM = 0, UCAL_LIMIT_GREATEST_MINIMUM, UCAL_LIMIT_LEAST_MAXIMUM, UCAL_LIMIT_MAXIMUM,
  UCAL_LIMIT_COUNT
}
 Limit enums. More...

enum  { kResolveSTOP = -1, kResolveRemap = 32 }
 Values for field resolution tables. More...

enum  { kUnset = 0, kInternallySet, kMinimumUserStamp }
 Special values of stamp[]. More...


Protected Methods

 Calendar (UErrorCode &success)
 Constructs a Calendar with the default time zone as returned by TimeZone::createInstance(), and the default locale. More...

 Calendar (const Calendar &source)
 Copy constructor. More...

Calendar & operator= (const Calendar &right)
 Default assignment operator. More...

 Calendar (TimeZone *zone, const Locale &aLocale, UErrorCode &success)
 Constructs a Calendar with the given time zone and locale. More...

 Calendar (const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
 Constructs a Calendar with the given time zone and locale. More...

virtual void computeTime (UErrorCode &status)
 Converts Calendar's time field values to GMT as milliseconds. More...

virtual void computeFields (UErrorCode &status)
 Converts GMT as milliseconds to time field values. More...

double getTimeInMillis (UErrorCode &status) const
 Gets this Calendar's current time as a long. More...

void setTimeInMillis (double millis, UErrorCode &status)
 Sets this Calendar's current time from the given long value. More...

void complete (UErrorCode &status)
 Recomputes the current time from currently set fields, and then fills in any unset fields in the time field list. More...

int32_t internalGet (EDateFields field) const
 Gets the value for a given time field. More...

int32_t internalGet (UCalendarDateFields field, int32_t defaultValue) const
 Gets the value for a given time field. More...

int32_t internalGet (UCalendarDateFields field) const
 Gets the value for a given time field. More...

void internalSet (EDateFields field, int32_t value)
 Sets the value for a given time field. More...

void internalSet (UCalendarDateFields field, int32_t value)
 Sets the value for a given time field. More...

virtual void prepareGetActual (UCalendarDateFields field, UBool isMinimum, UErrorCode &status)
 Prepare this calendar for computing the actual minimum or maximum. More...

virtual int32_t handleGetLimit (UCalendarDateFields field, ELimitType limitType) const=0
 Subclass API for defining limits of different types. More...

virtual int32_t getLimit (UCalendarDateFields field, ELimitType limitType) const
 Return a limit for a field. More...

virtual int32_t handleComputeMonthStart (int32_t eyear, int32_t month, UBool useMonth) const=0
 Return the Julian day number of day before the first day of the given month in the given extended year. More...

virtual int32_t handleGetMonthLength (int32_t extendedYear, int32_t month) const
 Return the number of days in the given month of the given extended year of this calendar system. More...

virtual int32_t handleGetYearLength (int32_t eyear) const
 Return the number of days in the given extended year of this calendar system. More...

virtual int32_t handleGetExtendedYear ()=0
 Return the extended year defined by the current fields. More...

virtual int32_t handleComputeJulianDay (UCalendarDateFields bestField)
 Subclasses may override this. More...

virtual int32_t handleGetExtendedYearFromWeekFields (int32_t yearWoy, int32_t woy)
 Subclasses must override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended year in the case where YEAR, EXTENDED_YEAR are not set. More...

int32_t computeJulianDay ()
 Compute the Julian day from fields. More...

int32_t computeMillisInDay ()
 Compute the milliseconds in the day from the fields. More...

int32_t computeZoneOffset (double millis, int32_t millisInDay, UErrorCode &ec)
 This method can assume EXTENDED_YEAR has been set. More...

int32_t newestStamp (UCalendarDateFields start, UCalendarDateFields end, int32_t bestSoFar) const
 Determine the best stamp in a range. More...

UCalendarDateFields resolveFields (const UFieldResolutionTable *precedenceTable)
 Given a precedence table, return the newest field combination in the table, or -1 (kResolveSTOP) if none is found. More...

virtual const UFieldResolutionTablegetFieldResolutionTable () const
UCalendarDateFields newerField (UCalendarDateFields defaultField, UCalendarDateFields alternateField) const
 Return the field that is newer, either defaultField, or alternateField. More...

UDate internalGetTime (void) const
 Get the current time without recomputing. More...

void internalSetTime (UDate time)
 Set the current time without affecting flags or fields. More...

virtual void handleComputeFields (int32_t julianDay, UErrorCode &status)
 Subclasses may override this method to compute several fields specific to each calendar system. More...

int32_t getGregorianYear () const
 Return the extended year on the Gregorian calendar as computed by computeGregorianFields(). More...

int32_t getGregorianMonth () const
 Return the month (0-based) on the Gregorian calendar as computed by computeGregorianFields(). More...

int32_t getGregorianDayOfYear () const
 Return the day of year (1-based) on the Gregorian calendar as computed by computeGregorianFields(). More...

int32_t getGregorianDayOfMonth () const
 Return the day of month (1-based) on the Gregorian calendar as computed by computeGregorianFields(). More...

virtual int32_t getDefaultMonthInYear ()
 Called by computeJulianDay. More...

virtual int32_t getDefaultDayInMonth (int32_t)
 Called by computeJulianDay. More...

virtual void pinField (UCalendarDateFields field, UErrorCode &status)
 Adjust the specified field so that it is within the allowable range for the date to which this calendar is set. More...

int32_t weekNumber (int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek)
 Return the week number of a day, within a period. More...

int32_t weekNumber (int32_t dayOfPeriod, int32_t dayOfWeek)
 Return the week number of a day, within a period. More...

int32_t getLocalDOW ()
 returns the local DOW, valid range 0..6. More...


Static Protected Methods

uint8_t julianDayToDayOfWeek (double julian)
 Convert a quasi Julian date to the day of the week. More...


Protected Attributes

UBool fIsTimeSet
 The flag which indicates if the current time is set in the calendar. More...

UBool fAreFieldsSet
 True if the fields are in sync with the currently set time of this Calendar. More...

UBool fAreAllFieldsSet
 True if all of the fields have been set. More...

int32_t fFields [UCAL_FIELD_COUNT]
 The time fields containing values into which the millis is computed. More...

UBool fIsSet [UCAL_FIELD_COUNT]
 The flags which tell if a specified time field for the calendar is set. More...

int32_t fStamp [UCAL_FIELD_COUNT]
 Pseudo-time-stamps which specify when each field was set. More...

char validLocale [50]
char actualLocale [50]

Static Protected Attributes

const UFieldResolutionTable kDatePrecedence []
 Precedence table for Dates. More...

const UFieldResolutionTable kYearPrecedence []
 Precedence table for Year. More...

const UFieldResolutionTable kDOWPrecedence []
 Precedence table for Day of Week. More...


Private Methods

int32_t getActualHelper (UCalendarDateFields field, int32_t startValue, int32_t endValue, UErrorCode &status) const
 Helper function for calculating limits by trial and error. More...

void setWeekCountData (const Locale &desiredLocale, UErrorCode &success)
 Sets firstDayOfWeek and minimalDaysInFirstWeek. More...

void updateTime (UErrorCode &status)
 Recompute the time and update the status fields isTimeSet and areFieldsSet. More...

void computeGregorianAndDOWFields (int32_t julianDay, UErrorCode &ec)
 Compute the Gregorian calendar year, month, and day of month from the given Julian day. More...

void computeGregorianFields (int32_t julianDay, UErrorCode &ec)
 Compute the Gregorian calendar year, month, and day of month from the Julian day. More...

void computeWeekFields (UErrorCode &ec)
 Compute the fields WEEK_OF_YEAR, YEAR_WOY, WEEK_OF_MONTH, DAY_OF_WEEK_IN_MONTH, and DOW_LOCAL from EXTENDED_YEAR, YEAR, DAY_OF_WEEK, and DAY_OF_YEAR. More...

void validateFields (UErrorCode &status)
 Ensure that each field is within its valid range by calling on each field that has been set. More...

virtual void validateField (UCalendarDateFields field, UErrorCode &status)
 Validate a single field of this calendar. More...

void validateField (UCalendarDateFields field, int32_t min, int32_t max, UErrorCode &status)
 Validate a single field of this calendar given its minimum and maximum allowed value. More...


Private Attributes

int32_t fNextStamp
 The next available value for fStamp[]. More...

UDate fTime
 The current time set for the calendar. More...

UBool fLenient
TimeZonefZone
 Time zone affects the time calculation done by Calendar. More...

UCalendarDaysOfWeek fFirstDayOfWeek
 Both firstDayOfWeek and minimalDaysInFirstWeek are locale-dependent. More...

uint8_t fMinimalDaysInFirstWeek
int32_t fGregorianYear
 The Gregorian year, as computed by computeGregorianFields() and returned by getGregorianYear(). More...

int32_t fGregorianMonth
 The Gregorian month, as computed by computeGregorianFields() and returned by getGregorianMonth(). More...

int32_t fGregorianDayOfYear
 The Gregorian day of the year, as computed by computeGregorianFields() and returned by getGregorianDayOfYear(). More...

int32_t fGregorianDayOfMonth
 The Gregorian day of the month, as computed by computeGregorianFields() and returned by getGregorianDayOfMonth(). More...


Static Private Attributes

const char kDateTimeElements []
 The resource tag for the resource where the week-count data is stored. More...

const char kDefaultCalendar []
 The resource tag where the default calendar is stored. More...


Friends

class CalendarFactory
 Multiple Calendar Implementation. More...

class CalendarService
 Multiple Calendar Implementation. More...

class DefaultCalendarFactory
 Multiple Calendar Implementation. More...


Detailed Description

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

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

Subclasses of Calendar interpret a UDate according to the rules of a specific calendar system. The most commonly used subclass of Calendar is GregorianCalendar. Other subclasses could represent the various types of lunar calendars in use in many parts of the world.

NOTE: (ICU 2.6) The subclass interface should be considered unstable

Like other locale-sensitive classes, Calendar provides a static method, createInstance, for getting a generally useful object of this type. Calendar's createInstance method returns the appropriate Calendar subclass whose time fields have been initialized with the current date and time:

 Calendar *rightNow = Calendar::createInstance(errCode);
 

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 UDate from time fields, two special circumstances may arise: there may be insufficient information to compute the UDate (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.

 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
 

For the time of day:

 HOUR_OF_DAY
 AM_PM + HOUR
 

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 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 December 12, 1996 results in January 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.

Stable:
ICU 2.0

Definition at line 165 of file calendar.h.


Member Enumeration Documentation

anonymous enum [protected]
 

Values for field resolution tables.

See also:
resolveFields
Internal:
For internal use only.
Enumeration values:
kResolveSTOP  Marker for end of resolve set (row or group).
kResolveRemap  Value to be bitwised "ORed" against resolve table field values for remapping.

Example: (UCAL_DATE | kResolveRemap) in 1st column will cause 'UCAL_DATE' to be returned, but will not examine the value of UCAL_DATE.

Definition at line 1474 of file calendar.h.

anonymous enum [protected]
 

Special values of stamp[].

Stable:
ICU 2.0
Enumeration values:
kUnset 
kInternallySet 
kMinimumUserStamp 

Definition at line 1611 of file calendar.h.

enum Calendar::EAmpm
 

Useful constants for hour in 12-hour clock.

Used in GregorianCalendar.

Deprecated:
ICU 2.6. Use C enum UCalendarAMPMs defined in ucal.h
Enumeration values:
AM 
PM 

Definition at line 238 of file calendar.h.

enum Calendar::EDateFields
 

Field IDs for date and time.

Used to specify date/time fields. ERA is calendar specific. Example ranges given are for illustration only; see specific Calendar subclasses for actual ranges.

Deprecated:
ICU 2.6. Use C enum UCalendarDateFields defined in ucal.h
Enumeration values:
ERA 
YEAR 
MONTH 
WEEK_OF_YEAR 
WEEK_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 
YEAR_WOY 
DOW_LOCAL 
FIELD_COUNT 

Definition at line 174 of file calendar.h.

enum Calendar::EDaysOfWeek
 

Useful constant for days of week.

Note: Calendar day-of-week is 1-based. Clients who create locale resources for the field of first-day-of-week should be aware of this. For instance, in US locale, first-day-of-week is set to 1, i.e., SUNDAY.

Deprecated:
ICU 2.6. Use C enum UCalendarDaysOfWeek defined in ucal.h
Enumeration values:
SUNDAY 
MONDAY 
TUESDAY 
WEDNESDAY 
THURSDAY 
FRIDAY 
SATURDAY 

Definition at line 204 of file calendar.h.

enum Calendar::ELimitType [protected]
 

Limit enums.

Not in sync with UCalendarLimitTypes (refers to internal fields).

Internal:
For internal use only.
Enumeration values:
UCAL_LIMIT_MINIMUM 
UCAL_LIMIT_GREATEST_MINIMUM 
UCAL_LIMIT_LEAST_MAXIMUM 
UCAL_LIMIT_MAXIMUM 
UCAL_LIMIT_COUNT 

Definition at line 1326 of file calendar.h.

enum Calendar::EMonths
 

Useful constants for month.

Note: Calendar month is 0-based.

Deprecated:
ICU 2.6. Use C enum UCalendarMonths defined in ucal.h
Enumeration values:
JANUARY 
FEBRUARY 
MARCH 
APRIL 
MAY 
JUNE 
JULY 
AUGUST 
SEPTEMBER 
OCTOBER 
NOVEMBER 
DECEMBER 
UNDECIMBER 

Definition at line 218 of file calendar.h.


Constructor & Destructor Documentation

virtual Calendar::~Calendar   [virtual]
 

destructor.

Stable:
ICU 2.0

Calendar::Calendar UErrorCode   success [protected]
 

Constructs a Calendar with the default time zone as returned by TimeZone::createInstance(), and the default locale.

Parameters:
success  Indicates the status of Calendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

Calendar::Calendar const Calendar &    source [protected]
 

Copy constructor.

Parameters:
source  Calendar object to be copied from
Stable:
ICU 2.0

Calendar::Calendar TimeZone   zone,
const Locale   aLocale,
UErrorCode   success
[protected]
 

Constructs a Calendar with the given time zone and locale.

Clients are no longer responsible for deleting the given time zone object after it's adopted.

Parameters:
zone  The given time zone.
aLocale  The given locale.
success  Indicates the status of Calendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

Calendar::Calendar const TimeZone   zone,
const Locale   aLocale,
UErrorCode   success
[protected]
 

Constructs a Calendar with the given time zone and locale.

Parameters:
zone  The given time zone.
aLocale  The given locale.
success  Indicates the status of Calendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0


Member Function Documentation

virtual void Calendar::add UCalendarDateFields    field,
int32_t    amount,
UErrorCode   status
[virtual]
 

UDate 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, call add(Calendar::DATE, -5). When adding on the month or Calendar::MONTH field, other fields like date might conflict and need to be changed. For instance, adding 1 month on the date 01/31/96 will result in 02/29/96.

Parameters:
field  Specifies which date field to modify.
amount  The amount of time to be added to the field, in the natural unit for that field (e.g., days for the day fields, hours for the hour field.)
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual void Calendar::add EDateFields    field,
int32_t    amount,
UErrorCode   status
[virtual]
 

UDate 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, call add(Calendar::DATE, -5). When adding on the month or Calendar::MONTH field, other fields like date might conflict and need to be changed. For instance, adding 1 month on the date 01/31/96 will result in 02/29/96.

Parameters:
field  Specifies which date field to modify.
amount  The amount of time to be added to the field, in the natural unit for that field (e.g., days for the day fields, hours for the hour field.)
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Deprecated:
ICU 2.6. use add(UCalendarDateFields field, int32_t amount, UErrorCode& status) instead.

void Calendar::adoptTimeZone TimeZone   value
 

Sets the calendar's time zone to be the one passed in.

The Calendar takes ownership of the TimeZone; the caller is no longer responsible for deleting it. If the given time zone is NULL, this function has no effect.

Parameters:
value  The given time zone.
Stable:
ICU 2.0

UBool Calendar::after const Calendar &    when,
UErrorCode   status
const
 

Returns true if this Calendar's current time is after "when"'s current time.

Parameters:
when  The Calendar to be compared with this Calendar. Although this is a const parameter, the object may be modified physically (semantically const).
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Returns:
True if the current time of this Calendar is after the time of Calendar when; false otherwise.
Stable:
ICU 2.0

UBool Calendar::before const Calendar &    when,
UErrorCode   status
const
 

Returns true if this Calendar's current time is before "when"'s current time.

Parameters:
when  The Calendar to be compared with this Calendar. Although this is a const parameter, the object may be modified physically (semantically const).
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Returns:
True if the current time of this Calendar is before the time of Calendar when; false otherwise.
Stable:
ICU 2.0

void Calendar::clear UCalendarDateFields    field
 

Clears the value in the given time field, both making it unset and assigning it a value of zero.

This field value will be determined during the next resolving of time into time fields.

Parameters:
field  The time field to be cleared.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

void Calendar::clear EDateFields    field
 

Clears the value in the given time field, both making it unset and assigning it a value of zero.

This field value will be determined during the next resolving of time into time fields.

Parameters:
field  The time field to be cleared.
Deprecated:
ICU 2.6. Use clear(UCalendarDateFields field) instead.

void Calendar::clear void   
 

Clears the values of all the time fields, making them both unset and assigning them a value of zero.

The field values will be determined during the next resolving of time into time fields.

Stable:
ICU 2.0

virtual Calendar* Calendar::clone void    const [pure virtual]
 

Create and return a polymorphic copy of this calendar.

Returns:
a polymorphic copy of this calendar.
Stable:
ICU 2.0

Reimplemented in GregorianCalendar.

void Calendar::complete UErrorCode   status [protected]
 

Recomputes the current time from currently set fields, and then fills in any unset fields in the time field list.

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Stable:
ICU 2.0

virtual void Calendar::computeFields UErrorCode   status [protected, virtual]
 

Converts GMT as milliseconds to time field values.

This allows you to sync up the time field values with a new time that is set for the calendar. This method does NOT recompute the time first; to recompute the time, then the fields, use the method complete().

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Stable:
ICU 2.0

void Calendar::computeGregorianAndDOWFields int32_t    julianDay,
UErrorCode   ec
[private]
 

Compute the Gregorian calendar year, month, and day of month from the given Julian day.

These values are not stored in fields, but in member variables gregorianXxx. Also compute the DAY_OF_WEEK and DOW_LOCAL fields.

void Calendar::computeGregorianFields int32_t    julianDay,
UErrorCode   ec
[private]
 

Compute the Gregorian calendar year, month, and day of month from the Julian day.

These values are not stored in fields, but in member variables gregorianXxx. They are used for time zone computations and by subclasses that are Gregorian derivatives. Subclasses may call this method to perform a Gregorian calendar millis->fields computation. To perform a Gregorian calendar fields->millis computation, call computeGregorianMonthStart().

See also:
computeGregorianMonthStart

int32_t Calendar::computeJulianDay   [protected]
 

Compute the Julian day from fields.

Will determine whether to use the JULIAN_DAY field directly, or other fields.

Returns:
the julian day
Internal:
For internal use only.

int32_t Calendar::computeMillisInDay   [protected]
 

Compute the milliseconds in the day from the fields.

This is a value from 0 to 23:59:59.999 inclusive, unless fields are out of range, in which case it can be an arbitrary value. This value reflects local zone wall time.

Internal:
For internal use only.

virtual void Calendar::computeTime UErrorCode   status [protected, virtual]
 

Converts Calendar's time field values to GMT as milliseconds.

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Stable:
ICU 2.0

void Calendar::computeWeekFields UErrorCode   ec [private]
 

Compute the fields WEEK_OF_YEAR, YEAR_WOY, WEEK_OF_MONTH, DAY_OF_WEEK_IN_MONTH, and DOW_LOCAL from EXTENDED_YEAR, YEAR, DAY_OF_WEEK, and DAY_OF_YEAR.

The latter fields are computed by the subclass based on the calendar system.

The YEAR_WOY field is computed simplistically. It is equal to YEAR most of the time, but at the year boundary it may be adjusted to YEAR-1 or YEAR+1 to reflect the overlap of a week into an adjacent year. In this case, a simple increment or decrement is performed on YEAR, even though this may yield an invalid YEAR value. For instance, if the YEAR is part of a calendar system with an N-year cycle field CYCLE, then incrementing the YEAR may involve incrementing CYCLE and setting YEAR back to 0 or 1. This is not handled by this code, and in fact cannot be simply handled without having subclasses define an entire parallel set of fields for fields larger than or equal to a year. This additional complexity is not warranted, since the intention of the YEAR_WOY field is to support ISO 8601 notation, so it will typically be used with a proleptic Gregorian calendar, which has no field larger than a year.

int32_t Calendar::computeZoneOffset double    millis,
int32_t    millisInDay,
UErrorCode   ec
[protected]
 

This method can assume EXTENDED_YEAR has been set.

Parameters:
millis  milliseconds of the date fields
millisInDay  milliseconds of the time fields; may be out or range.
Internal:
For internal use only.

Calendar* Calendar::createInstance const TimeZone   zoneToAdopt,
const Locale   aLocale,
UErrorCode   success
[static]
 

Gets a Calendar using the given timezone and given locale.

The TimeZone is _not_ adopted; the client is still responsible for deleting it.

Parameters:
zoneToAdopt  The given timezone to be adopted.
aLocale  The given locale.
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

Calendar* Calendar::createInstance TimeZone   zoneToAdopt,
const Locale   aLocale,
UErrorCode   success
[static]
 

Creates a Calendar using the given timezone and given locale.

The Calendar takes ownership of zoneToAdopt; the client must not delete it.

Parameters:
zoneToAdopt  The given timezone to be adopted.
aLocale  The given locale.
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

Calendar* Calendar::createInstance const Locale   aLocale,
UErrorCode   success
[static]
 

Creates a Calendar using the default timezone and the given locale.

Parameters:
aLocale  The given locale.
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

Calendar* Calendar::createInstance const TimeZone   zone,
UErrorCode   success
[static]
 

Creates a Calendar using the given timezone and the default locale.

The TimeZone is _not_ adopted; the client is still responsible for deleting it.

Parameters:
zone  The timezone.
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

Calendar * Calendar::createInstance TimeZone   zone,
UErrorCode   errorCode
[inline, static]
 

Creates a Calendar using the given timezone and the default locale.

The Calendar takes ownership of zoneToAdopt; the client must not delete it.

Parameters:
zoneToAdopt  The given timezone to be adopted.
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

Definition at line 2095 of file calendar.h.

Calendar* Calendar::createInstance UErrorCode   success [static]
 

Creates a Calendar using the default timezone and locale.

Clients are responsible for deleting the object returned.

Parameters:
success  Indicates the success/failure of Calendar creation. Filled in with U_ZERO_ERROR if created successfully, set to a failure result otherwise. U_MISSING_RESOURCE_ERROR will be returned if the resource data requests a calendar type which has not been installed.
Returns:
A Calendar if created successfully. NULL otherwise.
Stable:
ICU 2.0

virtual UDate Calendar::defaultCenturyStart   const [pure virtual]
 

Internal:
Returns:
the start of the default century, as a UDate

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::defaultCenturyStartYear   const [pure virtual]
 

Internal:
Returns:
the beginning year of the default century, as a year

Reimplemented in GregorianCalendar.

UBool Calendar::equals const Calendar &    when,
UErrorCode   status
const
 

Compares the Calendar time, whereas Calendar::operator== compares the equality of Calendar objects.

Parameters:
when  The Calendar to be compared with this Calendar. Although this is a const parameter, the object may be modified physically (semantically const).
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Returns:
True if the current time of this Calendar is equal to the time of Calendar when; false otherwise.
Stable:
ICU 2.0

virtual int32_t Calendar::fieldDifference UDate    when,
UCalendarDateFields    field,
UErrorCode   status
[virtual]
 

Return the difference between the given time and the time this calendar object is set to.

If this calendar is set before the given time, the returned value will be positive. If this calendar is set after the given time, the returned value will be negative. The field parameter specifies the units of the return value. For example, if fieldDifference(when, Calendar::MONTH) returns 3, then this calendar is set to 3 months before when, and possibly some addition time less than one month.

As a side effect of this call, this calendar is advanced toward when by the given amount. That is, calling this method has the side effect of calling add(field, n), where n is the return value.

Usage: To use this method, call it first with the largest field of interest, then with progressively smaller fields. For example:

 int y = cal->fieldDifference(when, Calendar::YEAR, err);
 int m = cal->fieldDifference(when, Calendar::MONTH, err);
 int d = cal->fieldDifference(when, Calendar::DATE, err);

computes the difference between cal and when in years, months, and days.

Note: fieldDifference() is asymmetrical. That is, in the following code:

 cal->setTime(date1, err);
 int m1 = cal->fieldDifference(date2, Calendar::MONTH, err);
 int d1 = cal->fieldDifference(date2, Calendar::DATE, err);
 cal->setTime(date2, err);
 int m2 = cal->fieldDifference(date1, Calendar::MONTH, err);
 int d2 = cal->fieldDifference(date1, Calendar::DATE, err);

one might expect that m1 == -m2 && d1 == -d2. However, this is not generally the case, because of irregularities in the underlying calendar system (e.g., the Gregorian calendar has a varying number of days per month).

Parameters:
when  the date to compare this calendar's time to
field  the field in which to compute the result
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Returns:
the difference, either positive or negative, between this calendar's time and when, in terms of field.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual int32_t Calendar::fieldDifference UDate    when,
EDateFields    field,
UErrorCode   status
[virtual]
 

Return the difference between the given time and the time this calendar object is set to.

If this calendar is set before the given time, the returned value will be positive. If this calendar is set after the given time, the returned value will be negative. The field parameter specifies the units of the return value. For example, if fieldDifference(when, Calendar::MONTH) returns 3, then this calendar is set to 3 months before when, and possibly some addition time less than one month.

As a side effect of this call, this calendar is advanced toward when by the given amount. That is, calling this method has the side effect of calling add(field, n), where n is the return value.

Usage: To use this method, call it first with the largest field of interest, then with progressively smaller fields. For example:

 int y = cal->fieldDifference(when, Calendar::YEAR, err);
 int m = cal->fieldDifference(when, Calendar::MONTH, err);
 int d = cal->fieldDifference(when, Calendar::DATE, err);

computes the difference between cal and when in years, months, and days.

Note: fieldDifference() is asymmetrical. That is, in the following code:

 cal->setTime(date1, err);
 int m1 = cal->fieldDifference(date2, Calendar::MONTH, err);
 int d1 = cal->fieldDifference(date2, Calendar::DATE, err);
 cal->setTime(date2, err);
 int m2 = cal->fieldDifference(date1, Calendar::MONTH, err);
 int d2 = cal->fieldDifference(date1, Calendar::DATE, err);

one might expect that m1 == -m2 && d1 == -d2. However, this is not generally the case, because of irregularities in the underlying calendar system (e.g., the Gregorian calendar has a varying number of days per month).

Parameters:
when  the date to compare this calendar's time to
field  the field in which to compute the result
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Returns:
the difference, either positive or negative, between this calendar's time and when, in terms of field.
Deprecated:
ICU 2.6. Use fieldDifference(UDate when, UCalendarDateFields field, UErrorCode& status).

int32_t Calendar::get UCalendarDateFields    field,
UErrorCode   status
const
 

Gets the value for a given time field.

Recalculate the current time field values if the time value has been changed by a call to setTime(). Return zero for unset fields if any fields have been explicitly set by a call to set(). To force a recomputation of all fields regardless of the previous state, call complete(). This method is semantically const, but may alter the object in memory.

Parameters:
field  The given time field.
status  Fill-in parameter which receives the status of the operation.
Returns:
The value for the given time field, or zero if the field is unset, and set() has been called for any other field.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

int32_t Calendar::get EDateFields    field,
UErrorCode   status
const
 

Gets the value for a given time field.

Recalculate the current time field values if the time value has been changed by a call to setTime(). Return zero for unset fields if any fields have been explicitly set by a call to set(). To force a recomputation of all fields regardless of the previous state, call complete(). This method is semantically const, but may alter the object in memory.

Parameters:
field  The given time field.
status  Fill-in parameter which receives the status of the operation.
Returns:
The value for the given time field, or zero if the field is unset, and set() has been called for any other field.
Deprecated:
ICU 2.6. Use get(UCalendarDateFields field, UErrorCode& status) instead.

int32_t Calendar::getActualHelper UCalendarDateFields    field,
int32_t    startValue,
int32_t    endValue,
UErrorCode   status
const [private]
 

Helper function for calculating limits by trial and error.

Parameters:
field  The field being investigated
startValue  starting (least max) value of field
endValue  ending (greatest max) value of field
status  return type
Internal:
For internal use only.

int32_t Calendar::getActualMaximum UCalendarDateFields    field,
UErrorCode   status
const
 

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
status  Fill-in parameter which receives the status of this operation.
Returns:
the maximum of the given field for the current date of this Calendar
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

Reimplemented in GregorianCalendar.

int32_t Calendar::getActualMaximum EDateFields    field,
UErrorCode   status
const
 

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
status  Fill-in parameter which receives the status of this operation.
Returns:
the maximum of the given field for the current date of this Calendar
Deprecated:
ICU 2.6. Use getActualMaximum(UCalendarDateFields field, UErrorCode& status) instead.

int32_t Calendar::getActualMinimum UCalendarDateFields    field,
UErrorCode   status
const
 

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
status  Fill-in parameter which receives the status of this operation.
Returns:
the minimum of the given field for the current date of this Calendar
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

int32_t Calendar::getActualMinimum EDateFields    field,
UErrorCode   status
const
 

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
status  Fill-in parameter which receives the status of this operation.
Returns:
the minimum of the given field for the current date of this Calendar
Deprecated:
ICU 2.6. Use getActualMinimum(UCalendarDateFields field, UErrorCode& status) instead.

StringEnumeration* Calendar::getAvailableLocales void    [static]
 

Return a StringEnumeration over the locales available at the time of the call, including registered locales.

Returns:
a StringEnumeration over the locales available at the time of the call
Internal:
For internal use only.

const Locale* Calendar::getAvailableLocales int32_t &    count [static]
 

Returns a list of the locales for which Calendars are installed.

Parameters:
count  Number of locales returned.
Returns:
An array of Locale objects representing the set of locales for which Calendars are installed. The system retains ownership of this list; the caller must NOT delete it. Does not include user-registered Calendars.
Stable:
ICU 2.0

virtual int32_t Calendar::getDefaultDayInMonth int32_t    [protected, virtual]
 

Called by computeJulianDay.

Returns the default day (1-based) for the month, taking currently-set year and era into account. Defaults to 1 for Gregorian.

Internal:
For internal use only.

virtual int32_t Calendar::getDefaultMonthInYear   [protected, virtual]
 

Called by computeJulianDay.

Returns the default month (0-based) for the year, taking year and era into account. Defaults to 0 for Gregorian, which doesn't care.

Internal:
Internal:
For internal use only.

virtual UClassID Calendar::getDynamicClassID void    const [pure virtual]
 

Returns a unique class ID POLYMORPHICALLY.

Pure virtual method. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.

Concrete subclasses of Calendar must implement getDynamicClassID() and also a static method and data member:

static UClassID getStaticClassID() { return (UClassID)&fgClassID; } static char fgClassID;

Returns:
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.
Stable:
ICU 2.0

Reimplemented from UObject.

Reimplemented in GregorianCalendar.

virtual const UFieldResolutionTable* Calendar::getFieldResolutionTable   const [protected, virtual]
 

UCalendarDaysOfWeek Calendar::getFirstDayOfWeek UErrorCode   status const
 

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

Parameters:
status  error code
Returns:
The first day of the week.
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

EDaysOfWeek Calendar::getFirstDayOfWeek void    const
 

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

Returns:
The first day of the week.
Deprecated:
ICU 2.6 use the overload with error code

virtual int32_t Calendar::getGreatestMinimum UCalendarDateFields    field const [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.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual int32_t Calendar::getGreatestMinimum EDateFields    field const [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.
Deprecated:
ICU 2.6. Use getGreatestMinimum(UCalendarDateFields field) instead.

int32_t Calendar::getGregorianDayOfMonth   const [inline, protected]
 

Return the day of month (1-based) on the Gregorian calendar as computed by computeGregorianFields().

See also:
computeGregorianFields
Internal:
For internal use only.

Definition at line 1687 of file calendar.h.

int32_t Calendar::getGregorianDayOfYear   const [inline, protected]
 

Return the day of year (1-based) on the Gregorian calendar as computed by computeGregorianFields().

See also:
computeGregorianFields
Internal:
For internal use only.

Definition at line 1677 of file calendar.h.

int32_t Calendar::getGregorianMonth   const [inline, protected]
 

Return the month (0-based) on the Gregorian calendar as computed by computeGregorianFields().

See also:
computeGregorianFields
Internal:
For internal use only.

Definition at line 1667 of file calendar.h.

int32_t Calendar::getGregorianYear   const [inline, protected]
 

Return the extended year on the Gregorian calendar as computed by computeGregorianFields().

See also:
computeGregorianFields
Internal:
For internal use only.

Definition at line 1657 of file calendar.h.

virtual int32_t Calendar::getLeastMaximum UCalendarDateFields    field const [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.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual int32_t Calendar::getLeastMaximum EDateFields    field const [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.
Deprecated:
ICU 2.6. Use getLeastMaximum(UCalendarDateFields field) instead.

virtual int32_t Calendar::getLimit UCalendarDateFields    field,
ELimitType    limitType
const [protected, virtual]
 

Return a limit for a field.

Parameters:
field  the field, from 0..UCAL_MAX_FIELD
limitType  the type specifier for the limit
See also:
ELimitType
Internal:
For internal use only.

int32_t Calendar::getLocalDOW   [protected]
 

returns the local DOW, valid range 0..6.

Internal:
For internal use only.

virtual Locale Calendar::getLocale ULocDataLocaleType    type,
UErrorCode   status
const [virtual]
 

Get the locale for this calendar object.

You can choose between valid and actual locale.

Parameters:
type  type of the locale we're looking for (valid or actual)
status  error code for the operation
Returns:
the locale
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

virtual const char* Calendar::getLocaleInternal ULocDataLocaleType    type,
UErrorCode   status
const [virtual]
 

Get the locale for this calendar object.

You can choose between valid and actual locale.

Parameters:
type  type of the locale we're looking for (valid or actual)
status  error code for the operation
Returns:
the locale
Internal:
For internal use only.

virtual int32_t Calendar::getMaximum UCalendarDateFields    field const [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.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual int32_t Calendar::getMaximum EDateFields    field const [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.
Deprecated:
ICU 2.6. Use getMaximum(UCalendarDateFields field) instead.

uint8_t Calendar::getMinimalDaysInFirstWeek void    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.

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.
Stable:
ICU 2.0

virtual int32_t Calendar::getMinimum UCalendarDateFields    field const [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.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

virtual int32_t Calendar::getMinimum EDateFields    field const [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.
Deprecated:
ICU 2.6. Use getMinimum(UCalendarDateFields field) instead.

UDate Calendar::getNow void    [static]
 

Returns the current UTC (GMT) time measured in milliseconds since 0:00:00 on 1/1/70 (derived from the system time).

Returns:
The current UTC time in milliseconds.
Stable:
ICU 2.0

UDate Calendar::getTime UErrorCode   status const [inline]
 

Gets this Calendar's time as milliseconds.

May involve recalculation of time due to previous calls to set time field values. The time specified is non-local UTC (GMT) time. Although this method is const, this object may actually be changed (semantically const).

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Returns:
The current time in UTC (GMT) time, or zero if the operation failed.
Stable:
ICU 2.0

Definition at line 371 of file calendar.h.

double Calendar::getTimeInMillis UErrorCode   status const [protected]
 

Gets this Calendar's current time as a long.

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Returns:
the current time as UTC milliseconds from the epoch.
Stable:
ICU 2.0

const TimeZone& Calendar::getTimeZone void    const
 

Returns a reference to the time zone owned by this calendar.

The returned reference is only valid until clients make another call to adoptTimeZone or setTimeZone, or this Calendar is destroyed.

Returns:
The time zone object associated with this calendar.
Stable:
ICU 2.0

virtual const char* Calendar::getType   const [pure virtual]
 

Returns the resource key string used for this calendar type.

For example, prepending "Eras_" to this string could return "Eras_japanese" or "Eras_gregorian".

Returns:
static string, for example, "gregorian" or "japanese"
Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual void Calendar::handleComputeFields int32_t    julianDay,
UErrorCode   status
[protected, virtual]
 

Subclasses may override this method to compute several fields specific to each calendar system.

These are:

  • ERA
  • YEAR
  • MONTH
  • DAY_OF_MONTH
  • DAY_OF_YEAR
  • EXTENDED_YEAR
Subclasses can refer to the DAY_OF_WEEK and DOW_LOCAL fields, which will be set when this method is called. Subclasses can also call the getGregorianXxx() methods to obtain Gregorian calendar equivalents for the given Julian day.

In addition, subclasses should compute any subclass-specific fields, that is, fields from BASE_FIELD_COUNT to getFieldCount() - 1.

The default implementation in Calendar implements a pure proleptic Gregorian calendar.

Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleComputeJulianDay UCalendarDateFields    bestField [protected, virtual]
 

Subclasses may override this.

This method calls handleGetMonthLength() to obtain the calendar-specific month length.

Parameters:
bestField  which field to use to calculate the date
Returns:
julian day specified by calendar fields.
Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleComputeMonthStart int32_t    eyear,
int32_t    month,
UBool    useMonth
const [protected, pure virtual]
 

Return the Julian day number of day before the first day of the given month in the given extended year.

Subclasses should override this method to implement their calendar system.

Parameters:
eyear  the extended year
month  the zero-based month, or 0 if useMonth is false
useMonth  if false, compute the day before the first day of the given year, otherwise, compute the day before the first day of the given month
return  the Julian day number of the day before the first day of the given month and year
Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleGetExtendedYear   [protected, pure virtual]
 

Return the extended year defined by the current fields.

This will use the UCAL_EXTENDED_YEAR field or the UCAL_YEAR and supra-year fields (such as UCAL_ERA) specific to the calendar system, depending on which set of fields is newer.

Returns:
the extended year
Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleGetExtendedYearFromWeekFields int32_t    yearWoy,
int32_t    woy
[protected, virtual]
 

Subclasses must override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended year in the case where YEAR, EXTENDED_YEAR are not set.

The Calendar implementation assumes yearWoy is in extended gregorian form

Internal:
Returns:
the extended year, UCAL_EXTENDED_YEAR

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleGetLimit UCalendarDateFields    field,
ELimitType    limitType
const [protected, pure virtual]
 

Subclass API for defining limits of different types.

Subclasses must implement this method to return limits for the following fields:

UCAL_ERA
 UCAL_YEAR
 UCAL_MONTH
 UCAL_WEEK_OF_YEAR
 UCAL_WEEK_OF_MONTH
 UCAL_DATE (DAY_OF_MONTH on Java)
 UCAL_DAY_OF_YEAR
 UCAL_DAY_OF_WEEK_IN_MONTH
 UCAL_YEAR_WOY
 UCAL_EXTENDED_YEAR
Parameters:
field  one of the above field numbers
limitType  one of MINIMUM, GREATEST_MINIMUM, LEAST_MAXIMUM, or MAXIMUM
Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleGetMonthLength int32_t    extendedYear,
int32_t    month
const [protected, virtual]
 

Return the number of days in the given month of the given extended year of this calendar system.

Subclasses should override this method if they can provide a more correct or more efficient implementation than the default implementation in Calendar.

Internal:
For internal use only.

Reimplemented in GregorianCalendar.

virtual int32_t Calendar::handleGetYearLength int32_t    eyear const [protected, virtual]
 

Return the number of days in the given extended year of this calendar system.

Subclasses should override this method if they can provide a more correct or more efficient implementation than the default implementation in Calendar.

Stable:
ICU 2.0

Reimplemented in GregorianCalendar.

virtual UBool Calendar::haveDefaultCentury   const [pure virtual]
 

Internal:
Returns:
TRUE if this calendar has a default century (i.e. 03 -> 2003)

Reimplemented in GregorianCalendar.

virtual UBool Calendar::inDaylightTime UErrorCode   status const [pure virtual]
 

Queries if the current date for this Calendar is in Daylight Savings Time.

Parameters:
status  Fill-in parameter which receives the status of this operation.
Returns:
True if the current date for this Calendar is in Daylight Savings Time, false, otherwise.
Stable:
ICU 2.0

Reimplemented in GregorianCalendar.

int32_t Calendar::internalGet UCalendarDateFields    field const [inline, protected]
 

Gets the value for a given time field.

Subclasses can use this function to get field values without forcing recomputation of time.

Parameters:
field  The given time field.
Returns:
The value for the given time field.
Internal:
For internal use only.

Definition at line 1290 of file calendar.h.

int32_t Calendar::internalGet UCalendarDateFields    field,
int32_t    defaultValue
const [inline, protected]
 

Gets the value for a given time field.

Subclasses can use this function to get field values without forcing recomputation of time. If the field's stamp is UNSET, the defaultValue is used.

Parameters:
field  The given time field.
defaultValue  a default value used if the field is unset.
Returns:
The value for the given time field.
Internal:
For internal use only.

Definition at line 1280 of file calendar.h.

int32_t Calendar::internalGet EDateFields    field const [inline, protected]
 

Gets the value for a given time field.

Subclasses can use this function to get field values without forcing recomputation of time.

Parameters:
field  The given time field.
Returns:
The value for the given time field.
Deprecated:
ICU 2.6. Use internalGet(UCalendarDateFields field) instead.

Definition at line 1268 of file calendar.h.

UDate Calendar::internalGetTime void    const [inline, protected]
 

Get the current time without recomputing.

Returns:
the current time without recomputing.
Stable:
ICU 2.0

Definition at line 1585 of file calendar.h.

void Calendar::internalSet UCalendarDateFields    field,
int32_t    value
[inline, protected]
 

Sets the value for a given time field.

This is a fast internal method for subclasses. It does not affect the areFieldsInSync, isTimeSet, or areAllFieldsSet flags.

Parameters:
field  The given time field.
value  The value for the given time field.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

Definition at line 2123 of file calendar.h.

void Calendar::internalSet EDateFields    field,
int32_t    value
[inline, protected]
 

Sets the value for a given time field.

This is a fast internal method for subclasses. It does not affect the areFieldsInSync, isTimeSet, or areAllFieldsSet flags.

Parameters:
field  The given time field.
value  The value for the given time field.
Deprecated:
ICU 2.6. Use internalSet(UCalendarDateFields field, int32_t value) instead.

Definition at line 2131 of file calendar.h.

void Calendar::internalSetTime UDate    time [inline, protected]
 

Set the current time without affecting flags or fields.

Parameters:
time  The time to be set
Returns:
the current time without recomputing.
Stable:
ICU 2.0

Definition at line 1594 of file calendar.h.

virtual UBool Calendar::isEquivalentTo const Calendar &    other const [virtual]
 

Returns TRUE if the given Calendar object is equivalent to this one.

An equivalent Calendar will behave exactly as this one does, but it may be set to a different time. By contrast, for the operator==() method to return TRUE, the other Calendar must be set to the same time.

Parameters:
other  the Calendar to be compared with this Calendar
Draft:
This API has been introduced in ICU 2.4. It is still in draft state and may be modified in a future release.

Reimplemented in GregorianCalendar.

UBool Calendar::isLenient void    const
 

Tells whether date/time interpretation is to be lenient.

Returns:
True tells that date/time interpretation is to be lenient.
Stable:
ICU 2.0

UBool Calendar::isSet UCalendarDateFields    field const
 

Determines if the given time field has a value set.

This can affect in the resolving of time in Calendar. Unset fields have a value of zero, by definition.

Parameters:
field  The given time field.
Returns:
True if the given time field has a value set; false otherwise.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

UBool Calendar::isSet EDateFields    field const
 

Determines if the given time field has a value set.

This can affect in the resolving of time in Calendar. Unset fields have a value of zero, by definition.

Parameters:
field  The given time field.
Returns:
True if the given time field has a value set; false otherwise.
Deprecated:
ICU 2.6. Use isSet(UCalendarDateFields field) instead.

uint8_t Calendar::julianDayToDayOfWeek double    julian [inline, static, protected]
 

Convert a quasi Julian date to the day of the week.

The Julian date used here is not a true Julian date, since it is measured from midnight, not noon. Return value is one-based.

Parameters:
julian  The given Julian date number.
Returns:
Day number from 1..7 (SUN..SAT).
Internal:
For internal use only.

Definition at line 2136 of file calendar.h.

UCalendarDateFields Calendar::newerField UCalendarDateFields    defaultField,
UCalendarDateFields    alternateField
const [protected]
 

Return the field that is newer, either defaultField, or alternateField.

If neither is newer or neither is set, return defaultField.

Internal:
For internal use only.

int32_t Calendar::newestStamp UCalendarDateFields    start,
UCalendarDateFields    end,
int32_t    bestSoFar
const [protected]
 

Determine the best stamp in a range.

Parameters:
start  first enum to look at
end  last enum to look at
best  stamp prior to function call
Returns:
the stamp value of the best stamp
Internal:
For internal use only.

UBool Calendar::operator!= const Calendar &    that const [inline]
 

Compares the inequality of two Calendar objects.

Parameters:
that  The Calendar object to be compared with.
Returns:
True if the given Calendar is not the same as this Calendar; false otherwise.
Stable:
ICU 2.0

Definition at line 406 of file calendar.h.

Calendar& Calendar::operator= const Calendar &    right [protected]
 

Default assignment operator.

Parameters:
right  Calendar object to be copied
Stable:
ICU 2.0

virtual UBool Calendar::operator== const Calendar &    that const [virtual]
 

Compares the equality of two Calendar objects.

Objects of different subclasses are considered unequal. This comparison is very exacting; two Calendar objects must be in exactly the same state to be considered equal. To compare based on the represented time, use equals() instead.

Parameters:
that  The Calendar object to be compared with.
Returns:
True if the given Calendar is the same as this Calendar; false otherwise.
Stable:
ICU 2.0

TimeZone* Calendar::orphanTimeZone void   
 

Returns the time zone owned by this calendar.

The caller owns the returned object and must delete it when done. After this call, the new time zone associated with this Calendar is the default TimeZone as returned by TimeZone::createDefault().

Returns:
The time zone object which was associated with this calendar.
Stable:
ICU 2.0

virtual void Calendar::pinField UCalendarDateFields    field,
UErrorCode   status
[protected, virtual]
 

Adjust the specified field so that it is within the allowable range for the date to which this calendar is set.

For example, in a Gregorian calendar pinning the DAY_OF_MONTH field for a calendar set to April 31 would cause it to be set to April 30.

Subclassing:
This utility method is intended for use by subclasses that need to implement their own overrides of roll and add.

Note: pinField is implemented in terms of getActualMinimum and getActualMaximum. If either of those methods uses a slow, iterative algorithm for a particular field, it would be unwise to attempt to call pinField for that field. If you really do need to do so, you should override this method to do something more efficient for that field.

Parameters:
field  The calendar field whose value should be pinned.
See also:
getActualMinimum , getActualMaximum
Stable:
ICU 2.0

virtual void Calendar::prepareGetActual UCalendarDateFields    field,
UBool    isMinimum,
UErrorCode   status
[protected, virtual]
 

Prepare this calendar for computing the actual minimum or maximum.

This method modifies this calendar's fields; it is called on a temporary calendar.

Internal:
For internal use only.

URegistryKey Calendar::registerFactory ICUServiceFactory   toAdopt,
UErrorCode   status
[static]
 

Register a new Calendar factory.

The factory will be adopted. INTERNAL in 2.6

Parameters:
toAdopt  the factory instance to be adopted
status  the in/out status code, no special meanings are assigned
Returns:
a registry key that can be used to unregister this factory
Internal:
For internal use only.

UCalendarDateFields Calendar::resolveFields const UFieldResolutionTable   precedenceTable [protected]
 

Given a precedence table, return the newest field combination in the table, or -1 (kResolveSTOP) if none is found.

The precedence table is a 3-dimensional array of integers. It may be thought of as an array of groups. Each group is an array of lines. Each line is an array of field numbers. Within a line, if all fields are set, then the time stamp of the line is taken to be the stamp of the most recently set field. If any field of a line is unset, then the line fails to match. Within a group, the line with the newest time stamp is selected. The first field of the line is returned to indicate which line matched.

In some cases, it may be desirable to map a line to field that whose stamp is NOT examined. For example, if the best field is DAY_OF_WEEK then the DAY_OF_WEEK_IN_MONTH algorithm may be used. In order to do this, insert the value kResolveRemap | F at the start of the line, where F is the desired return field value. This field will NOT be examined; it only determines the return value if the other fields in the line are the newest.

If all lines of a group contain at least one unset field, then no line will match, and the group as a whole will fail to match. In that case, the next group will be processed. If all groups fail to match, then -1 is returned.

Internal:
For internal use only.

virtual void Calendar::roll UCalendarDateFields    field,
int32_t    amount,
UErrorCode   status
[virtual]
 

Time Field Rolling function.

Rolls by the given amount on the given time field. For example, to roll the current date up by one day, call roll(Calendar::DATE, +1, status). 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 up on the date 01/31/96 will result in 02/29/96. Rolling by a positive value always means rolling forward in time; e.g., rolling the year by +1 on "100 BC" will result in "99 BC", for Gregorian calendar. 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.

The only difference between roll() and add() is that roll() does not change the value of more significant fields when it reaches the minimum or maximum of its range, whereas add() does.

Parameters:
field  The time field.
amount  Indicates amount to roll.
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

Reimplemented in GregorianCalendar.

virtual void Calendar::roll EDateFields    field,
int32_t    amount,
UErrorCode   status
[pure virtual]
 

Time Field Rolling function.

Rolls by the given amount on the given time field. For example, to roll the current date up by one day, call roll(Calendar::DATE, +1, status). 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 up on the date 01/31/96 will result in 02/29/96. Rolling by a positive value always means rolling forward in time; e.g., rolling the year by +1 on "100 BC" will result in "99 BC", for Gregorian calendar. 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.

The only difference between roll() and add() is that roll() does not change the value of more significant fields when it reaches the minimum or maximum of its range, whereas add() does.

Parameters:
field  The time field.
amount  Indicates amount to roll.
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Deprecated:
ICU 2.6. Use roll(UCalendarDateFields field, int32_t amount, UErrorCode& status) instead.

Reimplemented in GregorianCalendar.

void Calendar::roll UCalendarDateFields    field,
UBool    up,
UErrorCode   status
[inline]
 

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, call roll(Calendar::DATE, true). When rolling on the year or Calendar::YEAR field, it will roll the year value in the range between getMinimum(Calendar::YEAR) and the value returned by 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 up on the date 01/31/96 will result in 02/29/96. Rolling up always means rolling forward in time; e.g., rolling the year up on "100 BC" will result in "99 BC", for Gregorian calendar. 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.

NOTE: Do not use this method -- use roll(UCalendarDateFields, int, UErrorCode&) instead.

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.
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

Definition at line 2104 of file calendar.h.

void Calendar::roll EDateFields    field,
UBool    up,
UErrorCode   status
[inline]
 

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, call roll(Calendar::DATE, true). When rolling on the year or Calendar::YEAR field, it will roll the year value in the range between getMinimum(Calendar::YEAR) and the value returned by 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 up on the date 01/31/96 will result in 02/29/96. Rolling up always means rolling forward in time; e.g., rolling the year up on "100 BC" will result in "99 BC", for Gregorian calendar. 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.

NOTE: Do not use this method -- use roll(EDateFields, int, UErrorCode&) instead.

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.
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Deprecated:
ICU 2.6. Use roll(UCalendarDateFields field, UBool up, UErrorCode& status) instead.

Definition at line 2110 of file calendar.h.

Referenced by roll().

void Calendar::set int32_t    year,
int32_t    month,
int32_t    date,
int32_t    hour,
int32_t    minute,
int32_t    second
 

Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, MINUTE, and SECOND.

Other field values are retained; call clear() first if this is not desired.

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.
Stable:
ICU 2.0

void Calendar::set int32_t    year,
int32_t    month,
int32_t    date,
int32_t    hour,
int32_t    minute
 

Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, and MINUTE.

Other field values are retained; call clear() first if this is not desired.

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.
Stable:
ICU 2.0

void Calendar::set int32_t    year,
int32_t    month,
int32_t    date
 

Sets the values for the fields YEAR, MONTH, and DATE.

Other field values are retained; call clear() first if this is not desired.

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.
Stable:
ICU 2.0

void Calendar::set UCalendarDateFields    field,
int32_t    value
 

Sets the given time field with the given value.

Parameters:
field  The given time field.
value  The value to be set for the given time field.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

void Calendar::set EDateFields    field,
int32_t    value
 

Sets the given time field with the given value.

Parameters:
field  The given time field.
value  The value to be set for the given time field.
Deprecated:
ICU 2.6. Use set(UCalendarDateFields field, int32_t value) instead.

void Calendar::setFirstDayOfWeek UCalendarDaysOfWeek    value
 

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.
Draft:
This API has been introduced in ICU 2.6.. It is still in draft state and may be modified in a future release.

void Calendar::setFirstDayOfWeek EDaysOfWeek    value
 

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.
Deprecated:
ICU 2.6. Use setFirstDayOfWeek(UCalendarDaysOfWeek value) instead.

void Calendar::setLenient UBool    lenient
 

Specifies 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 error when computing time from the time field values representing the dates.

Parameters:
lenient  True specifies date/time interpretation to be lenient.
See also:
DateFormat::setLenient
Stable:
ICU 2.0

void Calendar::setMinimalDaysInFirstWeek uint8_t    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.

If it must be a full week, use value 7.

Parameters:
value  The given minimal days required in the first week of the year.
Stable:
ICU 2.0

void Calendar::setTime UDate    date,
UErrorCode   status
[inline]
 

Sets this Calendar's current time with the given UDate.

The time specified should be in non-local UTC (GMT) time.

Parameters:
date  The given UDate in UTC (GMT) time.
status  Output param set to success/failure code on exit. If any value set in the time field is invalid or restricted by leniency, this will be set to an error status.
Stable:
ICU 2.0

Definition at line 383 of file calendar.h.

void Calendar::setTimeInMillis double    millis,
UErrorCode   status
[protected]
 

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

Parameters:
millis  the new time in UTC milliseconds from the epoch.
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.
Stable:
ICU 2.0

void Calendar::setTimeZone const TimeZone   zone
 

Sets the calendar's time zone to be the same as the one passed in.

The TimeZone passed in is _not_ adopted; the client is still responsible for deleting it.

Parameters:
zone  The given time zone.
Stable:
ICU 2.0

void Calendar::setWeekCountData const Locale   desiredLocale,
UErrorCode   success
[private]
 

Sets firstDayOfWeek and minimalDaysInFirstWeek.

Called at Calendar construction time.

Parameters:
desiredLocale  The given locale.
success  Indicates the status of setting the week count data from the resource for the given locale. Returns U_ZERO_ERROR if constructed successfully.

UBool Calendar::unregister URegistryKey    key,
UErrorCode   status
[static]
 

Unregister a previously-registered CalendarFactory using the key returned from the register call.

Key becomes invalid after a successful call and should not be used again. The CalendarFactory corresponding to the key will be deleted. INTERNAL in 2.6

Parameters:
key  the registry key returned by a previous call to registerFactory
status  the in/out status code, no special meanings are assigned
Returns:
TRUE if the factory for the key was successfully unregistered
Internal:
For internal use only.

void Calendar::updateTime UErrorCode   status [private]
 

Recompute the time and update the status fields isTimeSet and areFieldsSet.

Callers should check isTimeSet and only call this method if isTimeSet is false.

Parameters:
status  Output param set to success/failure code on exit. If any value previously set in the time field is invalid or restricted by leniency, this will be set to an error status.

void Calendar::validateField UCalendarDateFields    field,
int32_t    min,
int32_t    max,
UErrorCode   status
[private]
 

Validate a single field of this calendar given its minimum and maximum allowed value.

If the field is out of range, U_ILLEGAL_ARGUMENT_ERROR will be set. Subclasses may use this method in their implementation of .

Internal:
For internal use only.

virtual void Calendar::validateField UCalendarDateFields    field,
UErrorCode   status
[private, virtual]
 

Validate a single field of this calendar.

Subclasses should override this method to validate any calendar-specific fields. Generic fields can be handled by Calendar.validateField().

See also:
validateField(int, int, int)
Internal:
For internal use only.

void Calendar::validateFields UErrorCode   status [private]
 

Ensure that each field is within its valid range by calling on each field that has been set.

This method should only be called if this calendar is not lenient.

See also:
isLenient , validateField(int)
Internal:
For internal use only.

int32_t Calendar::weekNumber int32_t    dayOfPeriod,
int32_t    dayOfWeek
[inline, protected]
 

Return the week number of a day, within a period.

This may be the week number in a year, or the week number in a month. Usually this will be a value >= 1, but if some initial days of the period are excluded from week 1, because getMinimalDaysInFirstWeek is > 1, then the week number will be zero for those initial days. This method requires the day of week for the given date in order to determine the result.

Subclassing:
This method is intended for use by subclasses in implementing their computeTime and/or computeFields methods. It is often useful in getActualMinimum and getActualMaximum as well.

Parameters:
dayOfPeriod  The DAY_OF_YEAR or DAY_OF_MONTH whose week number is desired. Should be 1 for the first day of the period.
dayofWeek  The DAY_OF_WEEK for the day corresponding to the dayOfPeriod parameter. 1-based with 1=Sunday.
Returns:
The week number (one-based), or zero if the day falls before the first week because getMinimalDaysInFirstWeek is more than one.
Internal:
For internal use only.

Definition at line 2146 of file calendar.h.

int32_t Calendar::weekNumber int32_t    desiredDay,
int32_t    dayOfPeriod,
int32_t    dayOfWeek
[protected]
 

Return the week number of a day, within a period.

This may be the week number in a year or the week number in a month. Usually this will be a value >= 1, but if some initial days of the period are excluded from week 1, because getMinimalDaysInFirstWeek is > 1, then the week number will be zero for those initial days. This method requires the day number and day of week for some known date in the period in order to determine the day of week on the desired day.

Subclassing:
This method is intended for use by subclasses in implementing their computeTime and/or computeFields methods. It is often useful in getActualMinimum and getActualMaximum as well.

This variant is handy for computing the week number of some other day of a period (often the first or last day of the period) when its day of the week is not known but the day number and day of week for some other day in the period (e.g. the current date) is known.

Parameters:
desiredDay  The DAY_OF_YEAR or DAY_OF_MONTH whose week number is desired. Should be 1 for the first day of the period.
knownDayOfPeriod  The DAY_OF_YEAR or DAY_OF_MONTH for a day in the period whose DAY_OF_WEEK is specified by the knownDayOfWeek parameter. Should be 1 for first day of period.
knownDayOfWeek  The DAY_OF_WEEK for the day corresponding to the knownDayOfPeriod parameter. 1-based with 1=Sunday.
Returns:
The week number (one-based), or zero if the day falls before the first week because getMinimalDaysInFirstWeek is more than one.

Referenced by weekNumber().


Friends And Related Function Documentation

friend class CalendarFactory [friend]
 

Multiple Calendar Implementation.

Internal:
For internal use only.

Definition at line 2043 of file calendar.h.

friend class CalendarService [friend]
 

Multiple Calendar Implementation.

Internal:
For internal use only.

Definition at line 2049 of file calendar.h.

friend class DefaultCalendarFactory [friend]
 

Multiple Calendar Implementation.

Internal:
For internal use only.

Definition at line 2055 of file calendar.h.


Member Data Documentation

char Calendar::actualLocale[50] [protected]
 

Definition at line 2002 of file calendar.h.

UBool Calendar::fAreAllFieldsSet [protected]
 

True if all of the fields have been set.

This is initially false, and set to true by computeFields().

Stable:
ICU 2.0

Definition at line 1577 of file calendar.h.

UBool Calendar::fAreFieldsSet [protected]
 

True if the fields are in sync with the currently set time of this Calendar.

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 the time field.

This should really be named areFieldsInSync, but the old name is retained for backward compatibility.

Stable:
ICU 2.0

Definition at line 1570 of file calendar.h.

int32_t Calendar::fFields[UCAL_FIELD_COUNT] [protected]
 

The time fields containing values into which the millis is computed.

Stable:
ICU 2.0

Definition at line 1600 of file calendar.h.

UCalendarDaysOfWeek Calendar::fFirstDayOfWeek [private]
 

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. For example, in US locale, firstDayOfWeek is SUNDAY; minimalDaysInFirstWeek is 1. 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.

Definition at line 1854 of file calendar.h.

int32_t Calendar::fGregorianDayOfMonth [private]
 

The Gregorian day of the month, as computed by computeGregorianFields() and returned by getGregorianDayOfMonth().

Definition at line 1912 of file calendar.h.

int32_t Calendar::fGregorianDayOfYear [private]
 

The Gregorian day of the year, as computed by computeGregorianFields() and returned by getGregorianDayOfYear().

Definition at line 1906 of file calendar.h.

int32_t Calendar::fGregorianMonth [private]
 

The Gregorian month, as computed by computeGregorianFields() and returned by getGregorianMonth().

Definition at line 1900 of file calendar.h.

int32_t Calendar::fGregorianYear [private]
 

The Gregorian year, as computed by computeGregorianFields() and returned by getGregorianYear().

Definition at line 1894 of file calendar.h.

UBool Calendar::fIsSet[UCAL_FIELD_COUNT] [protected]
 

The flags which tell if a specified time field for the calendar is set.

Deprecated:
ICU 2.8 use (fStamp[n]!=kUnset)

Definition at line 1606 of file calendar.h.

UBool Calendar::fIsTimeSet [protected]
 

The flag which indicates if the current time is set in the calendar.

Stable:
ICU 2.0

Definition at line 1558 of file calendar.h.

UBool Calendar::fLenient [private]
 

See also:
setLenient

Definition at line 1838 of file calendar.h.

uint8_t Calendar::fMinimalDaysInFirstWeek [private]
 

Definition at line 1855 of file calendar.h.

int32_t Calendar::fNextStamp [private]
 

The next available value for fStamp[].

Definition at line 1828 of file calendar.h.

int32_t Calendar::fStamp[UCAL_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.

Stable:
ICU 2.0

Definition at line 1623 of file calendar.h.

UDate Calendar::fTime [private]
 

The current time set for the calendar.

Definition at line 1833 of file calendar.h.

TimeZone* Calendar::fZone [private]
 

Time zone affects the time calculation done by Calendar.

Calendar subclasses use the time zone data to produce the local time.

Definition at line 1844 of file calendar.h.

const UFieldResolutionTable Calendar::kDOWPrecedence[] [static, protected]
 

Precedence table for Day of Week.

See also:
resolveFields
Internal:
For internal use only.

Definition at line 1500 of file calendar.h.

const UFieldResolutionTable Calendar::kDatePrecedence[] [static, protected]
 

Precedence table for Dates.

See also:
resolveFields
Internal:
For internal use only.

Definition at line 1486 of file calendar.h.

const char Calendar::kDateTimeElements[] [static, private]
 

The resource tag for the resource where the week-count data is stored.

Definition at line 1882 of file calendar.h.

const char Calendar::kDefaultCalendar[] [static, private]
 

The resource tag where the default calendar is stored.

Definition at line 1887 of file calendar.h.

const UFieldResolutionTable Calendar::kYearPrecedence[] [static, protected]
 

Precedence table for Year.

See also:
resolveFields
Internal:
For internal use only.

Definition at line 1493 of file calendar.h.

char Calendar::validLocale[50] [protected]
 

Definition at line 2001 of file calendar.h.


The documentation for this class was generated from the following file:
Generated on Mon Nov 24 14:36:20 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001