Added in API level 24

GregorianCalendar

Kotlin |Java

public class GregorianCalendar
extends Calendar

java.lang.Object
↳	android.icu.util.Calendar
	↳	android.icu.util.GregorianCalendar

Known direct subclasses

BuddhistCalendar, JapaneseCalendar, TaiwanCalendar

BuddhistCalendar	`BuddhistCalendar` is a subclass of `GregorianCalendar` that numbers years since the birth of the Buddha.
JapaneseCalendar	`JapaneseCalendar` is a subclass of `GregorianCalendar` that numbers years and eras based on the reigns of the Japanese emperors.
TaiwanCalendar	`TaiwanCalendar` is a subclass of `GregorianCalendar` that numbers years since 1912.

[icu enhancement] ICU's replacement for GregorianCalendar. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.

GregorianCalendar is a concrete subclass of Calendar and 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 instituted (October 15, 1582 in some countries, later in others). The cutover date may be changed by the caller by calling setGregorianChange().

Historically, in those countries which adopted the Gregorian calendar first, October 4, 1582 was thus followed by October 15, 1582. This calendar models this correctly. Before the Gregorian cutover, GregorianCalendar implements the Julian calendar. The only difference between the Gregorian and the Julian calendar is the leap year rule. The Julian calendar specifies leap years every four years, whereas the Gregorian calendar omits century years which are not divisible by 400.

GregorianCalendar implements proleptic Gregorian and Julian calendars. That is, dates are computed by extrapolating the current rules indefinitely far backward and forward in time. As a result, GregorianCalendar may be used for all years to generate meaningful and consistent results. However, dates obtained using GregorianCalendar are historically accurate only from March 1, 4 AD onward, when modern Julian calendar rules were adopted. Before this date, leap year rules were applied irregularly, and before 45 BC the Julian calendar did not even exist.

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 53. Week 1 for a year is the earliest seven day period starting on getFirstDayOfWeek() 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.

Values calculated for the WEEK_OF_MONTH field range from 0 or 1 to 4 or 5. Week 1 of a month (the days with WEEK_OF_MONTH = 1) is the earliest set of at least getMinimalDaysInFirstWeek() contiguous days in that month, ending on the day before getFirstDayOfWeek(). Unlike week 1 of a year, week 1 of a month may be shorter than 7 days, need not start on getFirstDayOfWeek(), and will not include days of the previous month. Days of a month before week 1 have a WEEK_OF_MONTH of 0.

For example, if getFirstDayOfWeek() is SUNDAY and getMinimalDaysInFirstWeek() is 4, then the first week of January 1998 is Sunday, January 4 through Saturday, January 10. These days have a WEEK_OF_MONTH of 1. Thursday, January 1 through Saturday, January 3 have a WEEK_OF_MONTH of 0. If getMinimalDaysInFirstWeek() is changed to 3, then January 1 through January 3 have a WEEK_OF_MONTH of 1.

Example:

 // get the supported ids for GMT-08:00 (Pacific Standard Time)
 String[] ids = TimeZone.getAvailableIDs(-8 * 60 * 60 * 1000);
 // if no ids were returned, something is wrong. get out.
 if (ids.length == 0)
     System.exit(0);

  // begin output
 System.out.println("Current Time");

 // create a Pacific Standard Time time zone
 SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, ids[0]);

 // set up rules for daylight savings time
 pdt.setStartRule(Calendar.MARCH, 2, Calendar.SUNDAY, 2 * 60 * 60 * 1000);
 pdt.setEndRule(Calendar.NOVEMBER, 1, Calendar.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);
 Date trialTime = new Date();
 calendar.setTime(trialTime);

 // print out a bunch of interesting things
 System.out.println("ERA: " + calendar.get(Calendar.ERA));
 System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
 System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
 System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
 System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
 System.out.println("DATE: " + calendar.get(Calendar.DATE));
 System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
 System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
 System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
 System.out.println("DAY_OF_WEEK_IN_MONTH: "
                    + calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
 System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
 System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
 System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
 System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
 System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
 System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
 System.out.println("ZONE_OFFSET: "
                    + (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000)));
 System.out.println("DST_OFFSET: "
                    + (calendar.get(Calendar.DST_OFFSET)/(60*60*1000)));

 System.out.println("Current Time, with hour reset to 3");
 calendar.clear(Calendar.HOUR_OF_DAY); // so doesn't override
 calendar.set(Calendar.HOUR, 3);
 System.out.println("ERA: " + calendar.get(Calendar.ERA));
 System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
 System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
 System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
 System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
 System.out.println("DATE: " + calendar.get(Calendar.DATE));
 System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
 System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
 System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
 System.out.println("DAY_OF_WEEK_IN_MONTH: "
                    + calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
 System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
 System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
 System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
 System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
 System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
 System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
 System.out.println("ZONE_OFFSET: "
        + (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000))); // in hours
 System.out.println("DST_OFFSET: "
        + (calendar.get(Calendar.DST_OFFSET)/(60*60*1000))); // in hours

GregorianCalendar usually should be instantiated using Calendar.getInstance(ULocale) passing in a ULocale with the tag "@calendar=gregorian".

See also:

Calendar
TimeZone

Summary

Constants
`int`	`AD` Value of the `ERA` field indicating the common era (Anno Domini), also known as CE.
`int`	`BC` Value of the `ERA` field indicating the period before the common era (before Christ), also known as BCE.

Inherited constants

From class android.icu.util.Calendar

`int`	`AM` Value of the `AM_PM` field indicating the period of the day from midnight to just before noon.
`int`	`AM_PM` Field number for `get` and `set` indicating whether the `HOUR` is before or after noon.
`int`	`APRIL` Value of the `MONTH` field indicating the fourth month of the year.
`int`	`AUGUST` Value of the `MONTH` field indicating the eighth month of the year.
`int`	`DATE` Field number for `get` and `set` indicating the day of the month.
`int`	`DAY_OF_MONTH` Field number for `get` and `set` indicating the day of the month.
`int`	`DAY_OF_WEEK` Field number for `get` and `set` indicating the day of the week.
`int`	`DAY_OF_WEEK_IN_MONTH` Field number for `get` and `set` indicating the ordinal number of the day of the week within the current month.
`int`	`DAY_OF_YEAR` Field number for `get` and `set` indicating the day number within the current year.
`int`	`DECEMBER` Value of the `MONTH` field indicating the twelfth month of the year.
`int`	`DOW_LOCAL` [icu] Field number for `get()` and `set()` indicating the localized day of week.
`int`	`DST_OFFSET` Field number for `get` and `set` indicating the daylight savings offset in milliseconds.
`int`	`EPOCH_JULIAN_DAY` The Julian day of the epoch, that is, January 1, 1970 on the Gregorian calendar.
`int`	`ERA` Field number for `get` and `set` indicating the era, e.g., AD or BC in the Julian calendar.
`int`	`EXTENDED_YEAR` [icu] Field number for `get()` and `set()` indicating the extended year.
`int`	`FEBRUARY` Value of the `MONTH` field indicating the second month of the year.
`int`	`FRIDAY` Value of the `DAY_OF_WEEK` field indicating Friday.
`int`	`GREATEST_MINIMUM` Limit type for `getLimit()` and `handleGetLimit()` indicating the greatest minimum value that a field can take.
`int`	`HOUR` Field number for `get` and `set` indicating the hour of the morning or afternoon.
`int`	`HOUR_OF_DAY` Field number for `get` and `set` indicating the hour of the day.
`int`	`INTERNALLY_SET` Value of the time stamp `stamp[]` indicating that a field has been set via computations from the time or from other fields.
`int`	`IS_LEAP_MONTH` [icu] Field indicating whether or not the current month is a leap month.
`int`	`JANUARY` Value of the `MONTH` field indicating the first month of the year.
`int`	`JAN_1_1_JULIAN_DAY` The Julian day of the Gregorian epoch, that is, January 1, 1 on the Gregorian calendar.
`int`	`JULIAN_DAY` [icu] Field number for `get()` and `set()` indicating the modified Julian day number.
`int`	`JULY` Value of the `MONTH` field indicating the seventh month of the year.
`int`	`JUNE` Value of the `MONTH` field indicating the sixth month of the year.
`int`	`LEAST_MAXIMUM` Limit type for `getLimit()` and `handleGetLimit()` indicating the least maximum value that a field can take.
`int`	`MARCH` Value of the `MONTH` field indicating the third month of the year.
`int`	`MAXIMUM` Limit type for `getLimit()` and `handleGetLimit()` indicating the maximum value that a field can take (greatest maximum).
`int`	`MAX_FIELD_COUNT` This constant was deprecated in API level 26. ICU 58 The numeric value may change over time, see ICU ticket #12420.
`int`	`MAX_JULIAN` The maximum supported Julian day.
`long`	`MAX_MILLIS` The maximum supported epoch milliseconds.
`int`	`MAY` Value of the `MONTH` field indicating the fifth month of the year.
`int`	`MILLISECOND` Field number for `get` and `set` indicating the millisecond within the second.
`int`	`MILLISECONDS_IN_DAY` [icu] Field number for `get()` and `set()` indicating the milliseconds in the day.
`int`	`MINIMUM` Limit type for `getLimit()` and `handleGetLimit()` indicating the minimum value that a field can take (least minimum).
`int`	`MINIMUM_USER_STAMP` If the time stamp `stamp[]` has a value greater than or equal to `MINIMUM_USER_SET` then it has been set by the user via a call to `set()`.
`int`	`MINUTE` Field number for `get` and `set` indicating the minute within the hour.
`int`	`MIN_JULIAN` The minimum supported Julian day.
`long`	`MIN_MILLIS` The minimum supported epoch milliseconds.
`int`	`MONDAY` Value of the `DAY_OF_WEEK` field indicating Monday.
`int`	`MONTH` Field number for `get` and `set` indicating the month.
`int`	`NOVEMBER` Value of the `MONTH` field indicating the eleventh month of the year.
`int`	`OCTOBER` Value of the `MONTH` field indicating the tenth month of the year.
`long`	`ONE_DAY` The number of milliseconds in one day.
`int`	`ONE_HOUR` The number of milliseconds in one hour.
`int`	`ONE_MINUTE` The number of milliseconds in one minute.
`int`	`ONE_SECOND` The number of milliseconds in one second.
`long`	`ONE_WEEK` The number of milliseconds in one week.
`int`	`ORDINAL_MONTH` [icu] Field indicating the month.
`int`	`PM` Value of the `AM_PM` field indicating the period of the day from noon to just before midnight.
`int`	`RESOLVE_REMAP` Value to OR against resolve table field values for remapping.
`int`	`SATURDAY` Value of the `DAY_OF_WEEK` field indicating Saturday.
`int`	`SECOND` Field number for `get` and `set` indicating the second within the minute.
`int`	`SEPTEMBER` Value of the `MONTH` field indicating the ninth month of the year.
`int`	`SUNDAY` Value of the `DAY_OF_WEEK` field indicating Sunday.
`int`	`THURSDAY` Value of the `DAY_OF_WEEK` field indicating Thursday.
`int`	`TUESDAY` Value of the `DAY_OF_WEEK` field indicating Tuesday.
`int`	`UNDECIMBER` Value of the `MONTH` field indicating the thirteenth month of the year.
`int`	`UNSET` Value of the time stamp `stamp[]` indicating that a field has not been set since the last call to `clear()`.
`int`	`WALLTIME_FIRST` [icu]Option used by `setRepeatedWallTimeOption(int)` and `setSkippedWallTimeOption(int)` specifying an ambiguous wall time to be interpreted as the earliest.
`int`	`WALLTIME_LAST` [icu]Option used by `setRepeatedWallTimeOption(int)` and `setSkippedWallTimeOption(int)` specifying an ambiguous wall time to be interpreted as the latest.
`int`	`WALLTIME_NEXT_VALID` [icu]Option used by `setSkippedWallTimeOption(int)` specifying an ambiguous wall time to be interpreted as the next valid wall time.
`int`	`WEDNESDAY` Value of the `DAY_OF_WEEK` field indicating Wednesday.
`int`	`WEEK_OF_MONTH` Field number for `get` and `set` indicating the week number within the current month.
`int`	`WEEK_OF_YEAR` Field number for `get` and `set` indicating the week number within the current year.
`int`	`YEAR` Field number for `get` and `set` indicating the year.
`int`	`YEAR_WOY` [icu] Field number for `get()` and `set()` indicating the extended year corresponding to the `WEEK_OF_YEAR` field.
`int`	`ZONE_OFFSET` Field number for `get` and `set` indicating the raw offset from GMT in milliseconds.

Fields
`protected boolean`	`invertGregorian` Used by handleComputeJulianDay() and handleComputeMonthStart().
`protected boolean`	`isGregorian` Used by handleComputeJulianDay() and handleComputeMonthStart().

Inherited fields

From class android.icu.util.Calendar

`protected static final Date`	`MAX_DATE` The maximum supported `Date`.
`protected static final Date`	`MIN_DATE` The minimum supported `Date`.

Public constructors
`GregorianCalendar()` Constructs a default GregorianCalendar using the current time in the default time zone with the default `FORMAT` locale.
`GregorianCalendar(TimeZone zone)` Constructs a GregorianCalendar based on the current time in the given time zone with the default `FORMAT` locale.
`GregorianCalendar(TimeZone zone, ULocale locale)` Constructs a GregorianCalendar based on the current time in the given time zone with the given locale.
`GregorianCalendar(TimeZone zone, Locale aLocale)` [icu] Constructs a GregorianCalendar based on the current time in the given time zone with the given locale.
`GregorianCalendar(ULocale locale)` [icu] Constructs a GregorianCalendar based on the current time in the default time zone with the given locale.
`GregorianCalendar(int year, int month, int date)` Constructs a GregorianCalendar with the given date set in the default time zone with the default `FORMAT` locale.
`GregorianCalendar(int year, int month, int date, int hour, int minute)` Constructs a GregorianCalendar with the given date and time set for the default time zone with the default `FORMAT` locale.
`GregorianCalendar(int year, int month, int date, int hour, int minute, int second)` Constructs a GregorianCalendar with the given date and time set for the default time zone with the default `FORMAT` locale.
`GregorianCalendar(Locale aLocale)` Constructs a GregorianCalendar based on the current time in the default time zone with the given locale.

Public methods
`int`	`getActualMaximum(int field)` Return the maximum value that this field could have, given the current date.
`int`	`getActualMinimum(int field)` Return the minimum value that this field could have, given the current date.
`final Date`	`getGregorianChange()` Gets the Gregorian Calendar change date.
`String`	`getType()` [icu] Returns the calendar type name string for this Calendar object.
`int`	`hashCode()` Override hashCode.
`boolean`	`isEquivalentTo(Calendar other)` Returns true if the given Calendar object is equivalent to this one.
`boolean`	`isLeapYear(int year)` Determines if the given year is a leap year.
`void`	`roll(int field, int amount)` Roll a field by a signed amount.
`void`	`setGregorianChange(Date date)` Sets the GregorianCalendar change date.

Protected methods
`void`	`handleComputeFields(int julianDay)` Override Calendar to compute several fields specific to the hybrid Gregorian-Julian calendar system.
`int`	`handleComputeJulianDay(int bestField)` Subclasses may override this.
`int`	`handleComputeMonthStart(int eyear, int month, boolean useMonth)` Return JD of start of given month/year
`int`	`handleGetExtendedYear()` Returns the extended year defined by the current fields.
`int`	`handleGetLimit(int field, int limitType)` Subclass API for defining limits of different types.
`int`	`handleGetMonthLength(int extendedYear, int month)` Returns the number of days in the given month of the given extended year of this calendar system.
`int`	`handleGetYearLength(int eyear)` Returns the number of days in the given extended year of this calendar system.

Inherited methods

From class


        
          android.icu.util.Calendar

`void`	`add(int field, int amount)` Add a signed amount to a specified field, using this calendar's rules.
`boolean`	`after(Object when)` Compares the time field records.
`boolean`	`before(Object when)` Compares the time field records.
`final void`	`clear()` Clears the values of all the time fields.
`final void`	`clear(int field)` Clears the value in the given time field.
`Object`	`clone()` Overrides Cloneable
`int`	`compareTo(Calendar that)` Compares the times (in millis) represented by two `Calendar` objects.
`void`	`complete()` Fills in any unset fields in the time field list.
`void`	`computeFields()` Converts the current millisecond time value `time` to field values in `fields[]`.
`final void`	`computeGregorianFields(int julianDay)` Compute the Gregorian calendar year, month, and day of month from the Julian day.
`int`	`computeGregorianMonthStart(int year, int month)` Compute the Julian day of a month of the Gregorian calendar.
`int`	`computeJulianDay()` Compute the Julian day number as specified by this calendar's fields.
`int`	`computeMillisInDay()` This method was deprecated in API level 26. ICU 60
`void`	`computeTime()` Converts the current field values in `fields[]` to the millisecond time value `time`.
`int`	`computeZoneOffset(long millis, int millisInDay)` This method was deprecated in API level 26. ICU 60
`boolean`	`equals(Object obj)` Compares this calendar to the specified object.
`int`	`fieldDifference(Date when, int field)` [icu] Returns the difference between the given time and the time this calendar object is set to.
`String`	`fieldName(int field)` Returns a string name for a field, for debugging and exceptions.
`static final int`	`floorDivide(int numerator, int denominator, int[] remainder)` Divide two integers, returning the floor of the quotient, and the modulus remainder.
`static final int`	`floorDivide(int numerator, int denominator)` Divide two integers, returning the floor of the quotient.
`static final long`	`floorDivide(long numerator, long denominator)` Divide two long integers, returning the floor of the quotient.
`static final int`	`floorDivide(long numerator, int denominator, int[] remainder)` Divide two integers, returning the floor of the quotient, and the modulus remainder.
`final int`	`get(int field)` Returns the value for a given time field.
`int`	`getActualMaximum(int field)` Returns the maximum value that this field could have, given the current date.
`int`	`getActualMinimum(int field)` Returns the minimum value that this field could have, given the current date.
`static Locale[]`	`getAvailableLocales()` Returns the list of locales for which Calendars are installed.
`DateFormat`	`getDateTimeFormat(int dateStyle, int timeStyle, ULocale loc)` [icu] Returns a `DateFormat` appropriate to this calendar.
`DateFormat`	`getDateTimeFormat(int dateStyle, int timeStyle, Locale loc)` [icu] Returns a `DateFormat` appropriate to this calendar.
`String`	`getDisplayName(ULocale loc)` Returns the name of this calendar in the language of the given locale.
`String`	`getDisplayName(Locale loc)` Returns the name of this calendar in the language of the given locale.
`final int`	`getFieldCount()` [icu] Returns the number of fields defined by this calendar.
`int[][][]`	`getFieldResolutionTable()` Returns the field resolution array for this calendar.
`int`	`getFirstDayOfWeek()` Returns what the first day of the week is, where 1 = `SUNDAY` and 7 = `SATURDAY`.
`final int`	`getGreatestMinimum(int field)` Returns the highest minimum value for the given field if varies.
`final int`	`getGregorianDayOfMonth()` Returns the day of month (1-based) on the Gregorian calendar as computed by `computeGregorianFields()`.
`final int`	`getGregorianDayOfYear()` Returns the day of year (1-based) on the Gregorian calendar as computed by `computeGregorianFields()`.
`final int`	`getGregorianMonth()` Returns the month (0-based) on the Gregorian calendar as computed by `computeGregorianFields()`.
`final int`	`getGregorianYear()` Returns the extended year on the Gregorian calendar as computed by `computeGregorianFields()`.
`static Calendar`	`getInstance()` Returns a calendar using the default time zone and locale.
`static Calendar`	`getInstance(Locale aLocale)` Returns a calendar using the default time zone and specified locale.
`static Calendar`	`getInstance(TimeZone zone, Locale aLocale)` Returns a calendar with the specified time zone and locale.
`static Calendar`	`getInstance(TimeZone zone, ULocale locale)` Returns a calendar with the specified time zone and locale.
`static Calendar`	`getInstance(TimeZone zone)` Returns a calendar using the specified time zone and default locale.
`static Calendar`	`getInstance(ULocale locale)` Returns a calendar using the default time zone and specified locale.
`static final String[]`	`getKeywordValuesForLocale(String key, ULocale locale, boolean commonlyUsed)` [icu] Given a key and a locale, returns an array of string values in a preferred order that would make a difference.
`final int`	`getLeastMaximum(int field)` Returns the lowest maximum value for the given field if varies.
`int`	`getLimit(int field, int limitType)` Returns a limit for a field.
`final int`	`getMaximum(int field)` Returns the maximum value for the given time field.
`int`	`getMinimalDaysInFirstWeek()` Returns what the minimal days required in the first week of the year are.
`final int`	`getMinimum(int field)` Returns the minimum value for the given time field.
`int`	`getRepeatedWallTimeOption()` [icu]Gets the behavior for handling wall time repeating multiple times at negative time zone offset transitions.
`int`	`getSkippedWallTimeOption()` [icu]Gets the behavior for handling skipped wall time at positive time zone offset transitions.
`final int`	`getStamp(int field)` Returns the timestamp of a field.
`String`	`getTemporalMonthCode()` Gets The Temporal monthCode value corresponding to the month for the date.
`final Date`	`getTime()` Returns this Calendar's current time.
`long`	`getTimeInMillis()` Returns this Calendar's current time as a long.
`TimeZone`	`getTimeZone()` Returns the time zone.
`String`	`getType()` [icu] Returns the calendar type name string for this Calendar object.
`Calendar.WeekData`	`getWeekData()` [icu] Return simple, immutable struct-like class for access to the week data in this calendar.
`static Calendar.WeekData`	`getWeekDataForRegion(String region)` [icu] Return simple, immutable struct-like class for access to the CLDR week data.
`static final int`	`gregorianMonthLength(int y, int m)` Returns the length of a month of the Gregorian calendar.
`static final int`	`gregorianPreviousMonthLength(int y, int m)` Returns the length of a previous month of the Gregorian calendar.
`void`	`handleComputeFields(int julianDay)` Subclasses may override this method to compute several fields specific to each calendar system.
`int`	`handleComputeJulianDay(int bestField)` Subclasses may override this.
`abstract int`	`handleComputeMonthStart(int eyear, int month, boolean useMonth)` Returns the Julian day number of day before the first day of the given month in the given extended year.
`int[]`	`handleCreateFields()` Subclasses that use additional fields beyond those defined in `Calendar` should override this method to return an `int[]` array of the appropriate length.
`DateFormat`	`handleGetDateFormat(String pattern, String override, Locale locale)` Creates a `DateFormat` appropriate to this calendar.
`DateFormat`	`handleGetDateFormat(String pattern, ULocale locale)` Creates a `DateFormat` appropriate to this calendar.
`DateFormat`	`handleGetDateFormat(String pattern, Locale locale)` Creates a `DateFormat` appropriate to this calendar.
`abstract int`	`handleGetExtendedYear()` Returns the extended year defined by the current fields.
`abstract int`	`handleGetLimit(int field, int limitType)` Subclass API for defining limits of different types.
`int`	`handleGetMonthLength(int extendedYear, int month)` Returns the number of days in the given month of the given extended year of this calendar system.
`int`	`handleGetYearLength(int eyear)` Returns the number of days in the given extended year of this calendar system.
`int`	`hashCode()` Returns a hash code for this calendar.
`boolean`	`inTemporalLeapYear()` [icu] Returns true if the date is in a leap year.
`final int`	`internalGet(int field)` Returns the value for a given time field.
`final int`	`internalGet(int field, int defaultValue)` Returns the value for a given time field, or return the given default value if the field is not set.
`final long`	`internalGetTimeInMillis()` Returns the current milliseconds without recomputing.
`final void`	`internalSet(int field, int value)` Set a field to a value.
`boolean`	`isEquivalentTo(Calendar other)` [icu] Returns true if the given Calendar object is equivalent to this one.
`static final boolean`	`isGregorianLeapYear(int year)` Determines if the given year is a leap year.
`boolean`	`isLenient()` Tell whether date/time interpretation is to be lenient.
`final boolean`	`isSet(int field)` Determines if the given time field has a value set.
`boolean`	`isWeekend(Date date)` [icu] Returns true if the given date and time is in the weekend in this calendar system.
`boolean`	`isWeekend()` [icu] Returns true if this Calendar's current date and time is in the weekend in this calendar system.
`static final int`	`julianDayToDayOfWeek(int julian)` Returns the day of week, from SUNDAY to SATURDAY, given a Julian day.
`static final long`	`julianDayToMillis(int julian)` Converts Julian day to time as milliseconds.
`static final int`	`millisToJulianDay(long millis)` Converts time as milliseconds to Julian day.
`int`	`newerField(int defaultField, int alternateField)` Returns the field that is newer, either defaultField, or alternateField.
`int`	`newestStamp(int first, int last, int bestStampSoFar)` Returns the newest stamp of a given range of fields.
`void`	`pinField(int field)` Adjust the specified field so that it is within the allowable range for the date to which this calendar is set.
`void`	`prepareGetActual(int field, boolean isMinimum)` Prepare this calendar for computing the actual minimum or maximum.
`int`	`resolveFields(int[][][] precedenceTable)` Given a precedence table, return the newest field combination in the table, or -1 if none is found.
`final void`	`roll(int field, boolean up)` Rolls (up/down) a single unit of time on the given field.
`void`	`roll(int field, int amount)` Rolls (up/down) a specified amount time on the given field.
`final void`	`set(int year, int month, int date, int hour, int minute, int second)` Sets the values for the fields year, month, date, hour, minute, and second.
`final void`	`set(int year, int month, int date, int hour, int minute)` Sets the values for the fields year, month, date, hour, and minute.
`final void`	`set(int field, int value)` Sets the time field with the given value.
`final void`	`set(int year, int month, int date)` Sets the values for the fields year, month, and date.
`void`	`setFirstDayOfWeek(int value)` Sets what the first day of the week is, where 1 = `SUNDAY` and 7 = `SATURDAY`.
`void`	`setLenient(boolean lenient)` Specify whether or not date/time interpretation is to be lenient.
`void`	`setMinimalDaysInFirstWeek(int value)` Sets what the minimal days required in the first week of the year are.
`void`	`setRepeatedWallTimeOption(int option)` [icu]Sets the behavior for handling wall time repeating multiple times at negative time zone offset transitions.
`void`	`setSkippedWallTimeOption(int option)` [icu]Sets the behavior for handling skipped wall time at positive time zone offset transitions.
`void`	`setTemporalMonthCode(String temporalMonth)` Sets The Temporal monthCode which is a string identifier that starts with the literal grapheme "M" followed by two graphemes representing the zero-padded month number of the current month in a normal (non-leap) year and suffixed by an optional literal grapheme "L" if this is a leap month in a lunisolar calendar.
`final void`	`setTime(Date date)` Sets this Calendar's current time with the given Date.
`void`	`setTimeInMillis(long millis)` Sets this Calendar's current time from the given long value.
`void`	`setTimeZone(TimeZone value)` Sets the time zone with the given time zone value.
`Calendar`	`setWeekData(Calendar.WeekData wdata)` [icu] Set data in this calendar based on the WeekData input.
`String`	`toString()` Returns a string representation of this calendar.
`void`	`validateField(int field)` Validate a single field of this calendar.
`final void`	`validateField(int field, int min, int max)` Validate a single field of this calendar given its minimum and maximum allowed value.
`void`	`validateFields()` Ensure that each field is within its valid range by calling `validateField(int)` on each field that has been set.
`int`	`weekNumber(int desiredDay, int dayOfPeriod, int dayOfWeek)` Returns the week number of a day, within a period.
`final int`	`weekNumber(int dayOfPeriod, int dayOfWeek)` Returns the week number of a day, within a period.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(Calendar o)

Compares this object with the specified object for order.

Constants

Added in API level 24

public static final int AD

Value of the ERA field indicating the common era (Anno Domini), also known as CE. The sequence of years at the transition from BC to AD is ..., 2 BC, 1 BC, 1 AD, 2 AD,...

See also:

Calendar.ERA

Constant Value: 1 (0x00000001)

BC

Added in API level 24

public static final int BC

Value of the ERA field indicating the period before the common era (before Christ), also known as BCE. The sequence of years at the transition from BC to AD is ..., 2 BC, 1 BC, 1 AD, 2 AD,...

See also:

Calendar.ERA

Constant Value: 0 (0x00000000)

Fields

invertGregorian

Added in API level 24

protected boolean invertGregorian

Used by handleComputeJulianDay() and handleComputeMonthStart().

isGregorian

Added in API level 24

protected boolean isGregorian

Used by handleComputeJulianDay() and handleComputeMonthStart().

Public constructors

GregorianCalendar

Added in API level 24

public GregorianCalendar ()

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

See also:

ULocale.Category.FORMAT

GregorianCalendar

Added in API level 24

public GregorianCalendar (TimeZone zone)

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

Parameters
`zone`	`TimeZone`: the given time zone.

See also:

ULocale.Category.FORMAT

GregorianCalendar

Added in API level 24

public GregorianCalendar (TimeZone zone, 
                ULocale locale)

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

Parameters
`zone`	`TimeZone`: the given time zone.
`locale`	`ULocale`: the given ulocale.

GregorianCalendar

Added in API level 24

public GregorianCalendar (TimeZone zone, 
                Locale aLocale)

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

Parameters
`zone`	`TimeZone`: the given time zone.
`aLocale`	`Locale`: the given locale.

GregorianCalendar

Added in API level 24

public GregorianCalendar (ULocale locale)

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

Parameters
`locale`	`ULocale`: the given ulocale.

GregorianCalendar

Added in API level 24

public GregorianCalendar (int year, 
                int month, 
                int date)

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

Parameters
`year`	`int`: the value used to set the YEAR time field in the calendar.
`month`	`int`: the value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
`date`	`int`: the value used to set the DATE time field in the calendar.

See also:

ULocale.Category.FORMAT

GregorianCalendar

Added in API level 24

public GregorianCalendar (int year, 
                int month, 
                int date, 
                int hour, 
                int minute)

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

Parameters
`year`	`int`: the value used to set the YEAR time field in the calendar.
`month`	`int`: the value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
`date`	`int`: the value used to set the DATE time field in the calendar.
`hour`	`int`: the value used to set the HOUR_OF_DAY time field in the calendar.
`minute`	`int`: the value used to set the MINUTE time field in the calendar.

See also:

ULocale.Category.FORMAT

GregorianCalendar

Added in API level 24

public GregorianCalendar (int year, 
                int month, 
                int date, 
                int hour, 
                int minute, 
                int second)

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

Parameters
`year`	`int`: the value used to set the YEAR time field in the calendar.
`month`	`int`: the value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
`date`	`int`: the value used to set the DATE time field in the calendar.
`hour`	`int`: the value used to set the HOUR_OF_DAY time field in the calendar.
`minute`	`int`: the value used to set the MINUTE time field in the calendar.
`second`	`int`: the value used to set the SECOND time field in the calendar.

See also:

ULocale.Category.FORMAT

GregorianCalendar

Added in API level 24

public GregorianCalendar (Locale aLocale)

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

Parameters
`aLocale`	`Locale`: the given locale.

Public methods

getActualMaximum

Added in API level 24

public int getActualMaximum (int field)

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
`field`	`int`: the field whose maximum is desired

Returns
`int`	the maximum of the given field for the current date of this calendar

getActualMinimum

Added in API level 24

public int getActualMinimum (int field)

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
`field`	`int`: the field whose actual minimum value is desired.

Returns
`int`	the minimum of the given field for the current date of this calendar

getGregorianChange

Added in API level 24

public final Date getGregorianChange ()

Gets the Gregorian Calendar change date. This is the point when the switch from Julian dates to Gregorian dates occurred. Default is October 15, 1582. Previous to this, dates will be in the Julian calendar.

Returns
`Date`	the Gregorian cutover date for this calendar.

getType

Added in API level 24

public String getType ()

[icu] 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".

See type="old type name" for the calendar attribute of locale IDs at http://www.unicode.org/reports/tr35/#Key_Type_Definitions

Returns
`String`	legacy calendar type name string

hashCode

Added in API level 24

public int hashCode ()

Override hashCode. Generates the hash code for the GregorianCalendar object

Returns
`int`	a hash code value for this object.

isEquivalentTo

Added in API level 24

public boolean isEquivalentTo (Calendar other)

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

Parameters
`other`	`Calendar`: the Calendar to be compared with this Calendar

Returns
`boolean`

isLeapYear

Added in API level 24

public boolean isLeapYear (int year)

Determines if the given year is a leap year. Returns true if the given year is a leap year.

Parameters
`year`	`int`: the given year.

Returns
`boolean`	true if the given year is a leap year; false otherwise.

roll

Added in API level 24

public void roll (int field, 
                int amount)

Roll a field by a signed amount.

Parameters
`field`	`int`: the calendar field to roll.
`amount`	`int`: the amount by which the field should be rolled.

setGregorianChange

Added in API level 24

public void setGregorianChange (Date date)

Sets the GregorianCalendar change date. This is the point when the switch from Julian dates to Gregorian dates occurred. Default is October 15, 1582. Previous to this, dates will be in the Julian calendar.

To obtain a pure Julian calendar, set the change date to Date(Long.MAX_VALUE). To obtain a pure Gregorian calendar, set the change date to Date(Long.MIN_VALUE).

Parameters
`date`	`Date`: the given Gregorian cutover date.

Protected methods

handleComputeFields

Added in API level 24

protected void handleComputeFields (int julianDay)

Override Calendar to compute several fields specific to the hybrid Gregorian-Julian calendar system. These are:

ERA
YEAR
MONTH
DAY_OF_MONTH
DAY_OF_YEAR
EXTENDED_YEAR

Parameters
`julianDay`	`int`

handleComputeJulianDay

Added in API level 24

protected int handleComputeJulianDay (int bestField)

Subclasses may override this. This method calls handleGetMonthLength() to obtain the calendar-specific month length.

Parameters
`bestField`	`int`

Returns
`int`

handleComputeMonthStart

Added in API level 24

protected int handleComputeMonthStart (int eyear, 
                int month, 
                boolean useMonth)

Return JD of start of given month/year

Parameters
`eyear`	`int`: the extended year
`month`	`int`: the zero-based month, or 0 if useMonth is false
`useMonth`	`boolean`: 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

Returns
`int`	the Julian day number of the day before the first day of the given month and year

handleGetExtendedYear

Added in API level 24

protected int handleGetExtendedYear ()

Returns the extended year defined by the current fields. This will use the EXTENDED_YEAR field or the YEAR and supra-year fields (such as ERA) specific to the calendar system, depending on which set of fields is newer.

Returns
`int`	the extended year

handleGetLimit

Added in API level 24

protected int handleGetLimit (int field, 
                int limitType)

Subclass API for defining limits of different types. Subclasses must implement this method to return limits for the following fields:

ERA
 YEAR
 MONTH
 WEEK_OF_YEAR
 WEEK_OF_MONTH
 DAY_OF_MONTH
 DAY_OF_YEAR
 DAY_OF_WEEK_IN_MONTH
 YEAR_WOY
 EXTENDED_YEAR

Parameters
`field`	`int`: one of the above field numbers
`limitType`	`int`: one of `MINIMUM`, `GREATEST_MINIMUM`, `LEAST_MAXIMUM`, or `MAXIMUM`

Returns
`int`

handleGetMonthLength

Added in API level 24

protected int handleGetMonthLength (int extendedYear, 
                int month)

Returns 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.

Parameters
`extendedYear`	`int`
`month`	`int`

Returns
`int`

handleGetYearLength

Added in API level 24

protected int handleGetYearLength (int eyear)

Returns 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.

Parameters
`eyear`	`int`

Returns
`int`