ICU 67.1  67.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 GregorianCalendarclone () 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)