ICU 59.1  59.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
icu::GregorianCalendar Class Reference

Concrete class which provides the standard calendar used by most of the world. More...

#include <gregocal.h>

Inheritance diagram for icu::GregorianCalendar:
icu::Calendar icu::UObject icu::UMemory

Public Types

enum  EEras { BC, AD }
 Useful constants for GregorianCalendar and TimeZone. More...
 
- Public Types inherited from icu::Calendar
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, EXTENDED_YEAR,
  JULIAN_DAY, MILLISECONDS_IN_DAY, IS_LEAP_MONTH, 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 Member Functions

 GregorianCalendar (UErrorCode &success)
 Constructs a default GregorianCalendar using the current time in the default time zone with the default locale. More...
 
 GregorianCalendar (TimeZone *zoneToAdopt, UErrorCode &success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the default locale. More...
 
 GregorianCalendar (const TimeZone &zone, UErrorCode &success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the default locale. More...
 
 GregorianCalendar (const Locale &aLocale, UErrorCode &success)
 Constructs a GregorianCalendar based on the current time in the default time zone with the given locale. More...
 
 GregorianCalendar (TimeZone *zoneToAdopt, const Locale &aLocale, UErrorCode &success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the given locale. More...
 
 GregorianCalendar (const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the given locale. More...
 
 GregorianCalendar (int32_t year, int32_t month, int32_t date, UErrorCode &success)
 Constructs a GregorianCalendar with the given AD date set in the default time zone with the default locale. More...
 
 GregorianCalendar (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode &success)
 Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale. More...
 
 GregorianCalendar (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode &success)
 Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale. More...
 
virtual ~GregorianCalendar ()
 Destructor. More...
 
 GregorianCalendar (const GregorianCalendar &source)
 Copy constructor. More...
 
GregorianCalendaroperator= (const GregorianCalendar &right)
 Default assignment operator. More...
 
virtual Calendarclone (void) const
 Create and return a polymorphic copy of this calendar. More...
 
void setGregorianChange (UDate date, UErrorCode &success)
 Sets the GregorianCalendar change date. More...
 
UDate getGregorianChange (void) const
 Gets the Gregorian Calendar change date. More...
 
UBool isLeapYear (int32_t year) const
 Return true if the given year is a leap year. More...
 
virtual UBool isEquivalentTo (const Calendar &other) const
 Returns TRUE if the given Calendar object is equivalent to this one. More...
 
virtual void roll (EDateFields field, int32_t amount, UErrorCode &status)
 (Overrides Calendar) Rolls up or down by the given amount in the specified field. More...
 
virtual void roll (UCalendarDateFields field, int32_t amount, UErrorCode &status)
 (Overrides Calendar) Rolls up or down by the given amount in the specified field. More...
 
int32_t getActualMinimum (EDateFields field) const
 Return the minimum value that this field could have, given the current date. 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) const
 Return the maximum value that this field could have, given the current date. More...
 
virtual int32_t getActualMaximum (UCalendarDateFields field, UErrorCode &status) const
 Return the maximum value that this field could have, given the current date. More...
 
virtual UBool inDaylightTime (UErrorCode &status) const
 (Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time. More...
 
virtual UClassID getDynamicClassID (void) const
 Override Calendar Returns a unique class ID POLYMORPHICALLY. More...
 
virtual const char * getType () const
 Returns the calendar type name string for this Calendar object. More...
 
virtual UBool haveDefaultCentury () const
 
virtual UDate defaultCenturyStart () const
 
virtual int32_t defaultCenturyStartYear () const
 
- Public Member Functions inherited from icu::Calendar
virtual ~Calendar ()
 destructor 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...
 
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 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...
 
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 setRepeatedWallTimeOption (UCalendarWallTimeOption option)
 Sets the behavior for handling wall time repeating multiple times at negative time zone offset transitions. More...
 
UCalendarWallTimeOption getRepeatedWallTimeOption (void) const
 Gets the behavior for handling wall time repeating multiple times at negative time zone offset transitions. More...
 
void setSkippedWallTimeOption (UCalendarWallTimeOption option)
 Sets the behavior for handling skipped wall time at positive time zone offset transitions. More...
 
UCalendarWallTimeOption getSkippedWallTimeOption (void) const
 Gets the behavior for handling skipped wall time at positive time zone offset transitions. 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 getActualMaximum (EDateFields 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 UCalendarWeekdayType getDayOfWeekType (UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const
 Returns whether the given day of the week is a weekday, a weekend day, or a day that transitions from one to the other, for the locale and calendar system associated with this Calendar (the locale's region is often the most determinant factor). More...
 
virtual int32_t getWeekendTransition (UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const
 Returns the time during the day at which the weekend begins or ends in this calendar system. More...
 
virtual UBool isWeekend (UDate date, UErrorCode &status) const
 Returns TRUE if the given UDate is in the weekend in this calendar system. More...
 
virtual UBool isWeekend (void) const
 Returns TRUE if this Calendar's current date-time is in the weekend in this calendar system. More...
 
Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this calendar object. More...
 
virtual int32_t getRelatedYear (UErrorCode &status) const
 
virtual void setRelatedYear (int32_t year)
 
const char * getLocaleID (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this calendar object. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 
- Static Public Member Functions inherited from icu::Calendar
static CalendarcreateInstance (UErrorCode &success)
 Creates a Calendar using the default timezone and locale. More...
 
static CalendarcreateInstance (TimeZone *zoneToAdopt, UErrorCode &success)
 Creates a Calendar using the given timezone and the default locale. More...
 
static CalendarcreateInstance (const TimeZone &zone, UErrorCode &success)
 Creates a Calendar using the given timezone and the default locale. More...
 
static CalendarcreateInstance (const Locale &aLocale, UErrorCode &success)
 Creates a Calendar using the default timezone and the given locale. More...
 
static CalendarcreateInstance (TimeZone *zoneToAdopt, const Locale &aLocale, UErrorCode &success)
 Creates a Calendar using the given timezone and given locale. More...
 
static CalendarcreateInstance (const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
 Gets a Calendar using the given timezone and given locale. More...
 
static const LocalegetAvailableLocales (int32_t &count)
 Returns a list of the locales for which Calendars are installed. More...
 
static StringEnumerationgetKeywordValuesForLocale (const char *key, const Locale &locale, UBool commonlyUsed, UErrorCode &status)
 Given a key and a locale, returns an array of string values in a preferred order that would make a difference. More...
 
static 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...
 
static StringEnumerationgetAvailableLocales (void)
 INTERNAL FOR 2.6 – Registration. More...
 
static URegistryKey registerFactory (ICUServiceFactory *toAdopt, UErrorCode &status)
 Register a new Calendar factory. More...
 
static UBool unregister (URegistryKey key, UErrorCode &status)
 Unregister a previously-registered CalendarFactory using the key returned from the register call. More...
 
static CalendarmakeInstance (const Locale &locale, UErrorCode &status)
 Creates a new Calendar from a Locale for the cache. More...
 
static void getCalendarTypeFromLocale (const Locale &locale, char *typeBuffer, int32_t typeBufferSize, UErrorCode &status)
 Get the calendar type for given locale. More...
 

Protected Member Functions

virtual int32_t internalGetEra () const
 Return the ERA. More...
 
virtual int32_t handleComputeMonthStart (int32_t eyear, int32_t month, UBool useMonth) const
 Return the Julian day number of day before the first day of the given month in the given extended year. More...
 
virtual int32_t handleComputeJulianDay (UCalendarDateFields bestField)
 Subclasses may override this. 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 monthLength (int32_t month) const
 return the length of the given month. More...
 
virtual int32_t monthLength (int32_t month, int32_t year) const
 return the length of the month according to the given year. More...
 
int32_t yearLength (int32_t year) const
 return the length of the given year. More...
 
int32_t yearLength (void) const
 return the length of the year field. More...
 
void pinDayOfMonth (void)
 After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around. More...
 
virtual UDate getEpochDay (UErrorCode &status)
 Return the day number with respect to the epoch. More...
 
virtual int32_t handleGetLimit (UCalendarDateFields field, ELimitType limitType) const
 Subclass API for defining limits of different types. More...
 
virtual int32_t handleGetExtendedYear ()
 Return the extended year defined by the current fields. More...
 
virtual int32_t handleGetExtendedYearFromWeekFields (int32_t yearWoy, int32_t woy)
 Subclasses may 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...
 
virtual void handleComputeFields (int32_t julianDay, UErrorCode &status)
 Subclasses may override this method to compute several fields specific to each calendar system. More...
 
- Protected Member Functions inherited from icu::Calendar
 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...
 
Calendaroperator= (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 getLimit (UCalendarDateFields field, ELimitType limitType) const
 Return a limit for a field. More...
 
virtual void validateField (UCalendarDateFields field, UErrorCode &status)
 Validate a single field of this calendar. 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 UCAL_FIELD_COUNT 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...
 
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 (int32_t eyear)
 Called by computeJulianDay. More...
 
virtual int32_t getDefaultDayInMonth (int32_t eyear, int32_t month)
 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...
 
void computeGregorianFields (int32_t julianDay, UErrorCode &ec)
 Compute the Gregorian calendar year, month, and day of month from the Julian day. More...
 

Additional Inherited Members

- Protected Types inherited from icu::Calendar
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...
 
- Static Protected Member Functions inherited from icu::Calendar
static uint8_t julianDayToDayOfWeek (double julian)
 Convert a quasi Julian date to the day of the week. More...
 
- Protected Attributes inherited from icu::Calendar
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...
 
UBool fAreFieldsVirtuallySet
 True if all fields have been virtually set, but have not yet been computed. 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...
 
- Static Protected Attributes inherited from icu::Calendar
static const UFieldResolutionTable kDatePrecedence []
 Precedence table for Dates. More...
 
static const UFieldResolutionTable kYearPrecedence []
 Precedence table for Year. More...
 
static const UFieldResolutionTable kDOWPrecedence []
 Precedence table for Day of Week. More...
 

Detailed Description

Concrete class which provides the standard calendar used by most of the world.

The standard (Gregorian) calendar has 2 eras, BC and AD.

This implementation handles a single discontinuity, which corresponds by default to the date the Gregorian calendar was originally instituted (October 15, 1582). Not all countries adopted the Gregorian calendar then, so this cutover date may be changed by the caller.

Prior to the institution of the Gregorian Calendar, New Year's Day was March 25. To avoid confusion, this Calendar always uses January 1. A manual adjustment may be made if desired for dates that are prior to the Gregorian changeover and which fall between January 1 and March 24.

Values calculated for the WEEK_OF_YEAR field range from 1 to

  1. Week 1 for a year is the first week that contains at least getMinimalDaysInFirstWeek() days from that year. It thus depends on the values of getMinimalDaysInFirstWeek(), getFirstDayOfWeek(), and the day of the week of January 1. Weeks between week 1 of one year and week 1 of the following year are numbered sequentially from 2 to 52 or 53 (as needed).

For example, January 1, 1998 was a Thursday. If getFirstDayOfWeek() is MONDAY and getMinimalDaysInFirstWeek() is 4 (these are the values reflecting ISO 8601 and many national standards), then week 1 of 1998 starts on December 29, 1997, and ends on January 4, 1998. If, however, getFirstDayOfWeek() is SUNDAY, then week 1 of 1998 starts on January 4, 1998, and ends on January 10, 1998; the first three days of 1998 then are part of week 53 of 1997.

Example for using GregorianCalendar:

// get the supported ids for GMT-08:00 (Pacific Standard Time)
const StringEnumeration *ids = TimeZone::createEnumeration(-8 * 60 * 60 * 1000);
// if no ids were returned, something is wrong. get out.
if (ids == 0 || ids->count(success) == 0) {
return;
}
// begin output
cout << "Current Time" << endl;
// create a Pacific Standard Time time zone
SimpleTimeZone* pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, ids->unext(NULL, success)));
// set up rules for daylight savings time
pdt->setStartRule(UCAL_MARCH, 1, UCAL_SUNDAY, 2 * 60 * 60 * 1000);
pdt->setEndRule(UCAL_NOVEMBER, 2, UCAL_SUNDAY, 2 * 60 * 60 * 1000);
// create a GregorianCalendar with the Pacific Daylight time zone
// and the current date and time
Calendar* calendar = new GregorianCalendar( pdt, success );
// print out a bunch of interesting things
cout << "ERA: " << calendar->get( UCAL_ERA, success ) << endl;
cout << "YEAR: " << calendar->get( UCAL_YEAR, success ) << endl;
cout << "MONTH: " << calendar->get( UCAL_MONTH, success ) << endl;
cout << "WEEK_OF_YEAR: " << calendar->get( UCAL_WEEK_OF_YEAR, success ) << endl;
cout << "WEEK_OF_MONTH: " << calendar->get( UCAL_WEEK_OF_MONTH, success ) << endl;
cout << "DATE: " << calendar->get( UCAL_DATE, success ) << endl;
cout << "DAY_OF_MONTH: " << calendar->get( UCAL_DAY_OF_MONTH, success ) << endl;
cout << "DAY_OF_YEAR: " << calendar->get( UCAL_DAY_OF_YEAR, success ) << endl;
cout << "DAY_OF_WEEK: " << calendar->get( UCAL_DAY_OF_WEEK, success ) << endl;
cout << "DAY_OF_WEEK_IN_MONTH: " << calendar->get( UCAL_DAY_OF_WEEK_IN_MONTH, success ) << endl;
cout << "AM_PM: " << calendar->get( UCAL_AM_PM, success ) << endl;
cout << "HOUR: " << calendar->get( UCAL_HOUR, success ) << endl;
cout << "HOUR_OF_DAY: " << calendar->get( UCAL_HOUR_OF_DAY, success ) << endl;
cout << "MINUTE: " << calendar->get( UCAL_MINUTE, success ) << endl;
cout << "SECOND: " << calendar->get( UCAL_SECOND, success ) << endl;
cout << "MILLISECOND: " << calendar->get( UCAL_MILLISECOND, success ) << endl;
cout << "ZONE_OFFSET: " << (calendar->get( UCAL_ZONE_OFFSET, success )/(60*60*1000)) << endl;
cout << "DST_OFFSET: " << (calendar->get( UCAL_DST_OFFSET, success )/(60*60*1000)) << endl;
cout << "Current Time, with hour reset to 3" << endl;
calendar->clear(UCAL_HOUR_OF_DAY); // so doesn't override
calendar->set(UCAL_HOUR, 3);
cout << "ERA: " << calendar->get( UCAL_ERA, success ) << endl;
cout << "YEAR: " << calendar->get( UCAL_YEAR, success ) << endl;
cout << "MONTH: " << calendar->get( UCAL_MONTH, success ) << endl;
cout << "WEEK_OF_YEAR: " << calendar->get( UCAL_WEEK_OF_YEAR, success ) << endl;
cout << "WEEK_OF_MONTH: " << calendar->get( UCAL_WEEK_OF_MONTH, success ) << endl;
cout << "DATE: " << calendar->get( UCAL_DATE, success ) << endl;
cout << "DAY_OF_MONTH: " << calendar->get( UCAL_DAY_OF_MONTH, success ) << endl;
cout << "DAY_OF_YEAR: " << calendar->get( UCAL_DAY_OF_YEAR, success ) << endl;
cout << "DAY_OF_WEEK: " << calendar->get( UCAL_DAY_OF_WEEK, success ) << endl;
cout << "DAY_OF_WEEK_IN_MONTH: " << calendar->get( UCAL_DAY_OF_WEEK_IN_MONTH, success ) << endl;
cout << "AM_PM: " << calendar->get( UCAL_AM_PM, success ) << endl;
cout << "HOUR: " << calendar->get( UCAL_HOUR, success ) << endl;
cout << "HOUR_OF_DAY: " << calendar->get( UCAL_HOUR_OF_DAY, success ) << endl;
cout << "MINUTE: " << calendar->get( UCAL_MINUTE, success ) << endl;
cout << "SECOND: " << calendar->get( UCAL_SECOND, success ) << endl;
cout << "MILLISECOND: " << calendar->get( UCAL_MILLISECOND, success ) << endl;
cout << "ZONE_OFFSET: " << (calendar->get( UCAL_ZONE_OFFSET, success )/(60*60*1000)) << endl; // in hours
cout << "DST_OFFSET: " << (calendar->get( UCAL_DST_OFFSET, success )/(60*60*1000)) << endl; // in hours
if (U_FAILURE(success)) {
cout << "An error occured. success=" << u_errorName(success) << endl;
}
delete ids;
delete calendar; // also deletes pdt
Stable:
ICU 2.0

Definition at line 151 of file gregocal.h.

Member Enumeration Documentation

§ EEras

Useful constants for GregorianCalendar and TimeZone.

Stable:
ICU 2.0

Definition at line 158 of file gregocal.h.

Constructor & Destructor Documentation

§ GregorianCalendar() [1/10]

icu::GregorianCalendar::GregorianCalendar ( UErrorCode success)

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

Parameters
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [2/10]

icu::GregorianCalendar::GregorianCalendar ( TimeZone zoneToAdopt,
UErrorCode success 
)

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

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

Parameters
zoneToAdoptThe given timezone.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [3/10]

icu::GregorianCalendar::GregorianCalendar ( const TimeZone zone,
UErrorCode success 
)

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

Parameters
zoneThe given timezone.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [4/10]

icu::GregorianCalendar::GregorianCalendar ( const Locale aLocale,
UErrorCode success 
)

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

Parameters
aLocaleThe given locale.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [5/10]

icu::GregorianCalendar::GregorianCalendar ( TimeZone zoneToAdopt,
const Locale aLocale,
UErrorCode success 
)

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

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

Parameters
zoneToAdoptThe given timezone.
aLocaleThe given locale.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [6/10]

icu::GregorianCalendar::GregorianCalendar ( const TimeZone zone,
const Locale aLocale,
UErrorCode success 
)

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

Parameters
zoneThe given timezone.
aLocaleThe given locale.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [7/10]

icu::GregorianCalendar::GregorianCalendar ( int32_t  year,
int32_t  month,
int32_t  date,
UErrorCode success 
)

Constructs a GregorianCalendar with the given AD date set in the default time zone with the default locale.

Parameters
yearThe value used to set the YEAR time field in the calendar.
monthThe value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
dateThe value used to set the DATE time field in the calendar.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [8/10]

icu::GregorianCalendar::GregorianCalendar ( int32_t  year,
int32_t  month,
int32_t  date,
int32_t  hour,
int32_t  minute,
UErrorCode success 
)

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

Parameters
yearThe value used to set the YEAR time field in the calendar.
monthThe value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
dateThe value used to set the DATE time field in the calendar.
hourThe value used to set the HOUR_OF_DAY time field in the calendar.
minuteThe value used to set the MINUTE time field in the calendar.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ GregorianCalendar() [9/10]

icu::GregorianCalendar::GregorianCalendar ( int32_t  year,
int32_t  month,
int32_t  date,
int32_t  hour,
int32_t  minute,
int32_t  second,
UErrorCode success 
)

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

Parameters
yearThe value used to set the YEAR time field in the calendar.
monthThe value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
dateThe value used to set the DATE time field in the calendar.
hourThe value used to set the HOUR_OF_DAY time field in the calendar.
minuteThe value used to set the MINUTE time field in the calendar.
secondThe value used to set the SECOND time field in the calendar.
successIndicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:
ICU 2.0

§ ~GregorianCalendar()

virtual icu::GregorianCalendar::~GregorianCalendar ( )
virtual

Destructor.

Stable:
ICU 2.0

§ GregorianCalendar() [10/10]

icu::GregorianCalendar::GregorianCalendar ( const GregorianCalendar source)

Copy constructor.

Parameters
sourcethe object to be copied.
Stable:
ICU 2.0

Member Function Documentation

§ clone()

virtual Calendar* icu::GregorianCalendar::clone ( void  ) const
virtual

Create and return a polymorphic copy of this calendar.

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

Implements icu::Calendar.

§ defaultCenturyStart()

virtual UDate icu::GregorianCalendar::defaultCenturyStart ( ) const
virtual
Returns
the start of the default century
Internal:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ defaultCenturyStartYear()

virtual int32_t icu::GregorianCalendar::defaultCenturyStartYear ( ) const
virtual
Returns
the beginning year of the default century
Internal:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ getActualMaximum() [1/2]

int32_t icu::GregorianCalendar::getActualMaximum ( EDateFields  field) 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.

Parameters
fieldthe time field.
Returns
the maximum value that this field could have, given the current date.
Deprecated:
ICU 2.6. Use getActualMaximum(UCalendarDateFields field) instead.

§ getActualMaximum() [2/2]

virtual int32_t icu::GregorianCalendar::getActualMaximum ( UCalendarDateFields  field,
UErrorCode status 
) const
virtual

Return the maximum value that this field could have, given the current date.

For example, with the date "Feb 3, 1997" and the DAY_OF_MONTH field, the actual maximum would be 28; for "Feb 3, 1996" it s 29. Similarly for a Hebrew calendar, for some years the actual maximum for MONTH is 12, and for others 13.

Parameters
fieldthe time field.
statusreturns any errors that may result from this function call.
Returns
the maximum value that this field could have, given the current date.
Stable:
ICU 2.6

Reimplemented from icu::Calendar.

§ getActualMinimum() [1/3]

int32_t icu::GregorianCalendar::getActualMinimum ( EDateFields  field) 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().

Parameters
fieldthe time field.
Returns
the minimum value that this field could have, given the current date.
Deprecated:
ICU 2.6. Use getActualMinimum(UCalendarDateFields field) instead.

§ getActualMinimum() [2/3]

int32_t icu::GregorianCalendar::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().

Parameters
fieldthe time field.
status
Returns
the minimum value that this field could have, given the current date.
Deprecated:
ICU 2.6. Use getActualMinimum(UCalendarDateFields field) instead. (Added to ICU 3.0 for signature consistency)

§ getActualMinimum() [3/3]

int32_t icu::GregorianCalendar::getActualMinimum ( UCalendarDateFields  field,
UErrorCode status 
) const
virtual

Return the minimum value that this field could have, given the current date.

For the Gregorian calendar, this is the same as getMinimum() and getGreatestMinimum().

Parameters
fieldthe time field.
statuserror result.
Returns
the minimum value that this field could have, given the current date.
Stable:
ICU 3.0

Reimplemented from icu::Calendar.

§ getDynamicClassID()

virtual UClassID icu::GregorianCalendar::getDynamicClassID ( void  ) const
virtual

Override Calendar Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. 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.

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

Implements icu::Calendar.

§ getEpochDay()

virtual UDate icu::GregorianCalendar::getEpochDay ( UErrorCode status)
protectedvirtual

Return the day number with respect to the epoch.

January 1, 1970 (Gregorian) is day zero.

Parameters
statusFill-in parameter which receives the status of this operation.
Returns
the day number with respect to the epoch.
Internal:
Do not use. This API is for internal use only.

§ getGregorianChange()

UDate icu::GregorianCalendar::getGregorianChange ( void  ) const

Gets the Gregorian Calendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

Returns
The Gregorian cutover time for this calendar.
Stable:
ICU 2.0

§ getStaticClassID()

static UClassID icu::GregorianCalendar::getStaticClassID ( void  )
static

Return the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

 Base* polymorphic_pointer = createPolymorphicObject();
 if (polymorphic_pointer->getDynamicClassID() ==
     Derived::getStaticClassID()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 2.0

§ getType()

virtual const char* icu::GregorianCalendar::getType ( ) const
virtual

Returns the calendar type name string for this Calendar object.

The returned string is the legacy ICU calendar attribute value, for example, "gregorian" or "japanese".

For more details see the Calendar::getType() documentation.

Returns
legacy calendar type name string
Stable:
ICU 49

Implements icu::Calendar.

§ handleComputeFields()

virtual void icu::GregorianCalendar::handleComputeFields ( int32_t  julianDay,
UErrorCode status 
)
protectedvirtual

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

The GregorianCalendar implementation implements a calendar with the specified Julian/Gregorian cutover date.

Internal:
Do not use. This API is for internal use only.

Reimplemented from icu::Calendar.

§ handleComputeJulianDay()

virtual int32_t icu::GregorianCalendar::handleComputeJulianDay ( UCalendarDateFields  bestField)
protectedvirtual

Subclasses may override this.

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

Parameters
bestFieldwhich field to use to calculate the date
Returns
julian day specified by calendar fields.
Internal:
Do not use. This API is for internal use only.

Reimplemented from icu::Calendar.

§ handleComputeMonthStart()

virtual int32_t icu::GregorianCalendar::handleComputeMonthStart ( int32_t  eyear,
int32_t  month,
UBool  useMonth 
) const
protectedvirtual

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
eyearthe extended year
monththe zero-based month, or 0 if useMonth is false
useMonthif false, compute the day before the first day of the given year, otherwise, compute the day before the first day of the given month
Returns
the Julian day number of the day before the first day of the given month and year
Internal:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ handleGetExtendedYear()

virtual int32_t icu::GregorianCalendar::handleGetExtendedYear ( )
protectedvirtual

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:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ handleGetExtendedYearFromWeekFields()

virtual int32_t icu::GregorianCalendar::handleGetExtendedYearFromWeekFields ( int32_t  yearWoy,
int32_t  woy 
)
protectedvirtual

Subclasses may 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 Gregorian implementation assumes a yearWoy in gregorian format, according to the current era.

Returns
the extended year, UCAL_EXTENDED_YEAR
Internal:
Do not use. This API is for internal use only.

Reimplemented from icu::Calendar.

§ handleGetLimit()

virtual int32_t icu::GregorianCalendar::handleGetLimit ( UCalendarDateFields  field,
ELimitType  limitType 
) const
protectedvirtual

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
fieldone of the above field numbers
limitTypeone of MINIMUM, GREATEST_MINIMUM, LEAST_MAXIMUM, or MAXIMUM
Internal:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ handleGetMonthLength()

virtual int32_t icu::GregorianCalendar::handleGetMonthLength ( int32_t  extendedYear,
int32_t  month 
) const
protectedvirtual

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:
Do not use. This API is for internal use only.

Reimplemented from icu::Calendar.

§ handleGetYearLength()

virtual int32_t icu::GregorianCalendar::handleGetYearLength ( int32_t  eyear) const
protectedvirtual

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 from icu::Calendar.

§ haveDefaultCentury()

virtual UBool icu::GregorianCalendar::haveDefaultCentury ( ) const
virtual
Returns
TRUE if this calendar has the notion of a default century
Internal:
Do not use. This API is for internal use only.

Implements icu::Calendar.

§ inDaylightTime()

virtual UBool icu::GregorianCalendar::inDaylightTime ( UErrorCode status) const
virtual

(Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time.

Recognizes DST_OFFSET, if it is set.

Parameters
statusFill-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

Implements icu::Calendar.

§ internalGetEra()

virtual int32_t icu::GregorianCalendar::internalGetEra ( ) const
protectedvirtual

Return the ERA.

We need a special method for this because the default ERA is AD, but a zero (unset) ERA is BC.

Returns
the ERA.
Internal:
Do not use. This API is for internal use only.

§ isEquivalentTo()

virtual UBool icu::GregorianCalendar::isEquivalentTo ( const Calendar other) const
virtual

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

Calendar override.

Parameters
otherthe Calendar to be compared with this Calendar
Stable:
ICU 2.4

Reimplemented from icu::Calendar.

§ isLeapYear()

UBool icu::GregorianCalendar::isLeapYear ( int32_t  year) const

Return true if the given year is a leap year.

Determination of whether a year is a leap year is actually very complicated. We do something crude and mostly correct here, but for a real determination you need a lot of contextual information. For example, in Sweden, the change from Julian to Gregorian happened in a complex way resulting in missed leap years and double leap years between 1700 and 1753. Another example is that after the start of the Julian calendar in 45 B.C., the leap years did not regularize until 8 A.D. This method ignores these quirks, and pays attention only to the Julian onset date and the Gregorian cutover (which can be changed).

Parameters
yearThe given year.
Returns
True if the given year is a leap year; false otherwise.
Stable:
ICU 2.0

§ monthLength() [1/2]

virtual int32_t icu::GregorianCalendar::monthLength ( int32_t  month) const
protectedvirtual

return the length of the given month.

Parameters
monththe given month.
Returns
the length of the given month.
Internal:
Do not use. This API is for internal use only.

§ monthLength() [2/2]

virtual int32_t icu::GregorianCalendar::monthLength ( int32_t  month,
int32_t  year 
) const
protectedvirtual

return the length of the month according to the given year.

Parameters
monththe given month.
yearthe given year.
Returns
the length of the month
Internal:
Do not use. This API is for internal use only.

§ operator=()

GregorianCalendar& icu::GregorianCalendar::operator= ( const GregorianCalendar right)

Default assignment operator.

Parameters
rightthe object to be copied.
Stable:
ICU 2.0

§ pinDayOfMonth()

void icu::GregorianCalendar::pinDayOfMonth ( void  )
protected

After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around.

E.g., we don't want Jan 31 + 1 month to go to Mar 3, we want it to go to Feb 28. Adjustments which might run into this problem call this method to retain the proper month.

Internal:
Do not use. This API is for internal use only.

§ roll() [1/2]

virtual void icu::GregorianCalendar::roll ( EDateFields  field,
int32_t  amount,
UErrorCode status 
)
virtual

(Overrides Calendar) Rolls up or down by the given amount in the specified field.

For more information, see the documentation for Calendar::roll().

Parameters
fieldThe time field.
amountIndicates amount to roll.
statusOutput 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 from icu::Calendar.

§ roll() [2/2]

virtual void icu::GregorianCalendar::roll ( UCalendarDateFields  field,
int32_t  amount,
UErrorCode status 
)
virtual

(Overrides Calendar) Rolls up or down by the given amount in the specified field.

For more information, see the documentation for Calendar::roll().

Parameters
fieldThe time field.
amountIndicates amount to roll.
statusOutput 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.
Stable:
ICU 2.6.

Reimplemented from icu::Calendar.

§ setGregorianChange()

void icu::GregorianCalendar::setGregorianChange ( UDate  date,
UErrorCode success 
)

Sets the GregorianCalendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

Parameters
dateThe given Gregorian cutover date.
successOutput param set to success/failure code on exit.
Stable:
ICU 2.0

§ yearLength() [1/2]

int32_t icu::GregorianCalendar::yearLength ( int32_t  year) const
protected

return the length of the given year.

Parameters
yearthe given year.
Returns
the length of the given year.
Internal:
Do not use. This API is for internal use only.

§ yearLength() [2/2]

int32_t icu::GregorianCalendar::yearLength ( void  ) const
protected

return the length of the year field.

Returns
the length of the year field
Internal:
Do not use. This API is for internal use only.

The documentation for this class was generated from the following file: