ICU 50.2 50.2
gregocal.h
Go to the documentation of this file.
1/*
2* Copyright (C) 1997-2012, International Business Machines Corporation and others.
3* All Rights Reserved.
4********************************************************************************
5*
6* File GREGOCAL.H
7*
8* Modification History:
9*
10* Date Name Description
11* 04/22/97 aliu Overhauled header.
12* 07/28/98 stephen Sync with JDK 1.2
13* 09/04/98 stephen Re-sync with JDK 8/31 putback
14* 09/14/98 stephen Changed type of kOneDay, kOneWeek to double.
15* Fixed bug in roll()
16* 10/15/99 aliu Fixed j31, incorrect WEEK_OF_YEAR computation.
17* Added documentation of WEEK_OF_YEAR computation.
18* 10/15/99 aliu Fixed j32, cannot set date to Feb 29 2000 AD.
19* {JDK bug 4210209 4209272}
20* 11/07/2003 srl Update, clean up documentation.
21********************************************************************************
22*/
23
24#ifndef GREGOCAL_H
25#define GREGOCAL_H
26
27#include "unicode/utypes.h"
28
29#if !UCONFIG_NO_FORMATTING
30
31#include "unicode/calendar.h"
32
37
39
150public:
151
156 enum EEras {
157 BC,
158 AD
159 };
160
170
181 GregorianCalendar(TimeZone* zoneToAdopt, UErrorCode& success);
182
192 GregorianCalendar(const TimeZone& zone, UErrorCode& success);
193
203 GregorianCalendar(const Locale& aLocale, UErrorCode& success);
204
216 GregorianCalendar(TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success);
217
228 GregorianCalendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
229
242 GregorianCalendar(int32_t year, int32_t month, int32_t date, UErrorCode& success);
243
258 GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode& success);
259
275 GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode& success);
276
282
289
296
302 virtual Calendar* clone(void) const;
303
313 void setGregorianChange(UDate date, UErrorCode& success);
314
324
340 UBool isLeapYear(int32_t year) const;
341
349 virtual UBool isEquivalentTo(const Calendar& other) const;
350
362 virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
363
375 virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
376
377#ifndef U_HIDE_DEPRECATED_API
385 int32_t getActualMinimum(EDateFields field) const;
386
395 int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
396#endif /* U_HIDE_DEPRECATED_API */
397
406 int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const;
407
408#ifndef U_HIDE_DEPRECATED_API
418 int32_t getActualMaximum(EDateFields field) const;
419#endif /* U_HIDE_DEPRECATED_API */
420
431 virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const;
432
442 virtual UBool inDaylightTime(UErrorCode& status) const;
443
444public:
445
456 virtual UClassID getDynamicClassID(void) const;
457
469 static UClassID U_EXPORT2 getStaticClassID(void);
470
471/* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
482 virtual const char * getType() const;
483
484 private:
485 GregorianCalendar(); // default constructor not implemented
486
487 protected:
494 virtual int32_t internalGetEra() const;
495
509 virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
510 UBool useMonth) const;
511
520 virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField) ;
521
529 virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const;
530
538 virtual int32_t handleGetYearLength(int32_t eyear) const;
539
546 virtual int32_t monthLength(int32_t month) const;
547
555 virtual int32_t monthLength(int32_t month, int32_t year) const;
556
557#ifndef U_HIDE_INTERNAL_API
564 int32_t yearLength(int32_t year) const;
565
571 int32_t yearLength(void) const;
572
580 void pinDayOfMonth(void);
581#endif /* U_HIDE_INTERNAL_API */
582
590 virtual UDate getEpochDay(UErrorCode& status);
591
613 virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const;
614
623 virtual int32_t handleGetExtendedYear();
624
633 virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);
634
635
651 virtual void handleComputeFields(int32_t julianDay, UErrorCode &status);
652
653 private:
661 static double computeJulianDayOfYear(UBool isGregorian, int32_t year,
662 UBool& isLeap);
663
668 UBool validateFields(void) const;
669
673 UBool boundsCheck(int32_t value, UCalendarDateFields field) const;
674
684 int32_t aggregateStamp(int32_t stamp_a, int32_t stamp_b);
685
694 UDate fGregorianCutover;
695
699 int32_t fCutoverJulianDay;
700
706 UDate fNormalizedGregorianCutover;// = gregorianCutover;
707
712 int32_t fGregorianCutoverYear;// = 1582;
713
718 int32_t fGregorianCutoverJulianDay;// = 2299161;
719
727 static double millisToJulianDay(UDate millis);
728
736 static UDate julianDayToMillis(double julian);
737
742 UBool fIsGregorian;
743
749 UBool fInvertGregorian;
750
751
752 public: // internal implementation
753
758 virtual UBool haveDefaultCentury() const;
759
764 virtual UDate defaultCenturyStart() const;
765
770 virtual int32_t defaultCenturyStartYear() const;
771
772 private:
779 static UDate fgSystemDefaultCenturyStart;
780
784 static int32_t fgSystemDefaultCenturyStartYear;
785
789 static const int32_t fgSystemDefaultCenturyYear;
790
794 static const UDate fgSystemDefaultCentury;
795
802 UDate internalGetDefaultCenturyStart(void) const;
803
810 int32_t internalGetDefaultCenturyStartYear(void) const;
811
816 static void initializeSystemDefaultCentury(void);
817
818};
819
821
822#endif /* #if !UCONFIG_NO_FORMATTING */
823
824#endif // _GREGOCAL
825//eof
826
C++ API: Calendar object.
Calendar(UErrorCode &success)
Constructs a Calendar with the default time zone as returned by TimeZone::createInstance(),...
EDateFields
Field IDs for date and time.
Definition calendar.h:209
ELimitType
Limit enums.
Definition calendar.h:1609
GregorianCalendar(TimeZone *zoneToAdopt, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
GregorianCalendar(const TimeZone &zone, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
virtual const char * getType() const
Returns the calendar type name string for this Calendar object.
GregorianCalendar & operator=(const GregorianCalendar &right)
Default assignment operator.
virtual UBool inDaylightTime(UErrorCode &status) const
(Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time.
static UClassID getStaticClassID(void)
Return the class ID for this class.
virtual UBool isEquivalentTo(const Calendar &other) const
Returns TRUE if the given Calendar object is equivalent to this one.
virtual Calendar * clone(void) const
Create and return a polymorphic copy of this calendar.
int32_t getActualMinimum(EDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
int32_t getActualMaximum(EDateFields field) const
Return the maximum value that this field could have, given the current date.
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status)
Subclasses may override this method to compute several fields specific to each calendar system.
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...
virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode &status)
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
int32_t yearLength(void) const
return the length of the year field.
UDate getGregorianChange(void) const
Gets the Gregorian Calendar change date.
UBool isLeapYear(int32_t year) const
Return true if the given year is a leap year.
virtual int32_t defaultCenturyStartYear() const
virtual int32_t handleGetYearLength(int32_t eyear) const
Return the number of days in the given extended year of this calendar system.
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField)
Subclasses may override this.
virtual ~GregorianCalendar()
Destructor.
void setGregorianChange(UDate date, UErrorCode &success)
Sets the GregorianCalendar change date.
virtual UClassID getDynamicClassID(void) const
Override Calendar Returns a unique class ID POLYMORPHICALLY.
GregorianCalendar(const Locale &aLocale, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the default time zone with the given loca...
GregorianCalendar(const GregorianCalendar &source)
Copy constructor.
virtual UDate defaultCenturyStart() const
virtual int32_t internalGetEra() const
Return the ERA.
virtual UDate getEpochDay(UErrorCode &status)
Return the day number with respect to the epoch.
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.
int32_t yearLength(int32_t year) const
return the length of the given year.
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 y...
virtual void roll(EDateFields field, int32_t amount, UErrorCode &status)
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
virtual int32_t handleGetExtendedYear()
Return the extended year defined by the current fields.
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...
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...
virtual int32_t monthLength(int32_t month) const
return the length of the given month.
virtual int32_t monthLength(int32_t month, int32_t year) const
return the length of the month according to the given year.
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 yea...
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const
Subclass API for defining limits of different types.
virtual UBool haveDefaultCentury() const
int32_t getActualMinimum(EDateFields field) const
Return the minimum value that this field could have, given the current date.
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...
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 l...
GregorianCalendar(UErrorCode &success)
Constructs a default GregorianCalendar using the current time in the default time zone with the defau...
void pinDayOfMonth(void)
After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around.
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode &status) const
Return the maximum value that this field could have, given the current date.
EEras
Useful constants for GregorianCalendar and TimeZone.
Definition gregocal.h:156
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:182
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition timezone.h:129
UCalendarDateFields
Possible fields in a UCalendar.
Definition ucal.h:183
int8_t UBool
The ICU boolean type.
Definition umachine.h:200
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:96
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:476
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:358
double UDate
Date and Time data type.
Definition utypes.h:201
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:130
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:129