Added in API level 26

HijrahChronology

class HijrahChronology : AbstractChronology, Serializable

The Hijrah calendar is a lunar calendar supporting Islamic calendars.

The HijrahChronology follows the rules of the Hijrah calendar system. The Hijrah calendar has several variants based on differences in when the new moon is determined to have occurred and where the observation is made. In some variants the length of each month is computed algorithmically from the astronomical data for the moon and earth and in others the length of the month is determined by an authorized sighting of the new moon. For the algorithmically based calendars the calendar can project into the future. For sighting based calendars only historical data from past sightings is available.

The length of each month is 29 or 30 days. Ordinary years have 354 days; leap years have 355 days.

CLDR and LDML identify variants:

Variants of Hijrah Calendars
Chronology ID Calendar Type Locale extension, see java.util.Locale Description
Hijrah-umalqura islamic-umalqura ca-islamic-umalqura Islamic - Umm Al-Qura calendar of Saudi Arabia

Additional variants may be available through Chronology.getAvailableChronologies().

Example

Selecting the chronology from the locale uses Chronology.ofLocale to find the Chronology based on Locale supported BCP 47 extension mechanism to request a specific calendar ("ca"). For example,

Locale locale = Locale.forLanguageTag("en-US-u-ca-islamic-umalqura");
       Chronology chrono = Chronology.ofLocale(locale);
  

Summary

Public methods
HijrahDate!
date(prolepticYear: Int, month: Int, dayOfMonth: Int)

Obtains a local date in Hijrah calendar system from the proleptic-year, month-of-year and day-of-month fields.

HijrahDate!
date(era: Era!, yearOfEra: Int, month: Int, dayOfMonth: Int)

Obtains a local date in Hijrah calendar system from the era, year-of-era, month-of-year and day-of-month fields.

HijrahDate!
date(temporal: TemporalAccessor!)

HijrahDate!
dateEpochDay(epochDay: Long)

Obtains a local date in the Hijrah calendar system from the epoch-day.

HijrahDate!

HijrahDate!
dateNow(clock: Clock!)

HijrahDate!
dateNow(zone: ZoneId!)

HijrahDate!
dateYearDay(prolepticYear: Int, dayOfYear: Int)

Obtains a local date in Hijrah calendar system from the proleptic-year and day-of-year fields.

HijrahDate!
dateYearDay(era: Era!, yearOfEra: Int, dayOfYear: Int)

Obtains a local date in Hijrah calendar system from the era, year-of-era and day-of-year fields.

HijrahEra!
eraOf(eraValue: Int)

Creates the HijrahEra object from the numeric value.

MutableList<Era!>!

String!

Gets the calendar type of the Islamic calendar.

String!

Gets the ID of the chronology.

Boolean
isLeapYear(prolepticYear: Long)

ChronoLocalDateTime<HijrahDate!>!

Int
prolepticYear(era: Era!, yearOfEra: Int)

ValueRange!
range(field: ChronoField!)

HijrahDate!
resolveDate(fieldValues: MutableMap<TemporalField!, Long!>!, resolverStyle: ResolverStyle!)

ChronoZonedDateTime<HijrahDate!>!
zonedDateTime(instant: Instant!, zone: ZoneId!)

ChronoZonedDateTime<HijrahDate!>!

Inherited functions
Int compareTo(other: Chronology!)

Compares this chronology to another chronology.

The comparison order first by the chronology ID string, then by any additional information specific to the subclass. It is "consistent with equals", as defined by Comparable.

Boolean equals(other: Any?)

Checks if this chronology is equal to another chronology.

The comparison is based on the entire state of the object.

Int hashCode()

A hash code for this chronology.

The hash code should be based on the entire state of the object.

String toString()

Outputs this chronology as a String, using the chronology ID.

ChronoLocalDate! date(prolepticYear: Int, month: Int, dayOfMonth: Int)

Obtains a local date in this chronology from the proleptic-year, month-of-year and day-of-month fields.

ChronoLocalDate! date(era: Era!, yearOfEra: Int, month: Int, dayOfMonth: Int)

Obtains a local date in this chronology from the era, year-of-era, month-of-year and day-of-month fields.

ChronoLocalDate! date(temporal: TemporalAccessor!)

Obtains a local date in this chronology from another temporal object.

This obtains a date in this chronology based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ChronoLocalDate.

The conversion typically uses the EPOCH_DAY field, which is standardized across calendar systems.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, aChronology::date.

ChronoLocalDate! dateEpochDay(epochDay: Long)

Obtains a local date in this chronology from the epoch-day.

The definition of EPOCH_DAY is the same for all calendar systems, thus it can be used for conversion.

ChronoLocalDate! dateNow()

Obtains the current local date in this chronology from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current date.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

ChronoLocalDate! dateNow(clock: Clock!)

Obtains the current local date in this chronology from the specified clock.

This will query the specified clock to obtain the current date - today. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

ChronoLocalDate! dateNow(zone: ZoneId!)

Obtains the current local date in this chronology from the system clock in the specified time-zone.

This will query the system clock to obtain the current date. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

ChronoLocalDate! dateYearDay(prolepticYear: Int, dayOfYear: Int)

Obtains a local date in this chronology from the proleptic-year and day-of-year fields.

ChronoLocalDate! dateYearDay(era: Era!, yearOfEra: Int, dayOfYear: Int)

Obtains a local date in this chronology from the era, year-of-era and day-of-year fields.

Long epochSecond(prolepticYear: Int, month: Int, dayOfMonth: Int, hour: Int, minute: Int, second: Int, zoneOffset: ZoneOffset!)

Gets the number of seconds from the epoch of 1970-01-01T00:00:00Z.

The number of seconds is calculated using the proleptic-year, month, day-of-month, hour, minute, second, and zoneOffset.

Long epochSecond(era: Era!, yearOfEra: Int, month: Int, dayOfMonth: Int, hour: Int, minute: Int, second: Int, zoneOffset: ZoneOffset!)

Gets the number of seconds from the epoch of 1970-01-01T00:00:00Z.

The number of seconds is calculated using the era, year-of-era, month, day-of-month, hour, minute, second, and zoneOffset.

Era! eraOf(eraValue: Int)

Creates the chronology era object from the numeric value.

The era is, conceptually, the largest division of the time-line. Most calendar systems have a single epoch dividing the time-line into two eras. However, some have multiple eras, such as one for the reign of each leader. The exact meaning is determined by the chronology according to the following constraints.

The era in use at 1970-01-01 must have the value 1. Later eras must have sequentially higher values. Earlier eras must have sequentially lower values. Each chronology must refer to an enum or similar singleton to provide the era values.

This method returns the singleton era of the correct type for the specified era value.

MutableList<Era!>! eras()

Gets the list of eras for the chronology.

Most calendar systems have an era, within which the year has meaning. If the calendar system does not support the concept of eras, an empty list must be returned.

String! getCalendarType()

Gets the calendar type of the calendar system.

The calendar type is an identifier defined by the CLDR and Unicode Locale Data Markup Language (LDML) specifications to uniquely identify a calendar. The getCalendarType is the concatenation of the CLDR calendar type and the variant, if applicable, is appended separated by "-". The calendar type is used to lookup the Chronology using of(java.lang.String).

String! getDisplayName(style: TextStyle!, locale: Locale!)

Gets the textual representation of this chronology.

This returns the textual name used to identify the chronology, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

String! getId()

Gets the ID of the chronology.

The ID uniquely identifies the Chronology. It can be used to lookup the Chronology using of(java.lang.String).

Boolean isLeapYear(prolepticYear: Long)

Checks if the specified year is a leap year.

A leap-year is a year of a longer length than normal. The exact meaning is determined by the chronology according to the following constraints.

  • a leap-year must imply a year-length longer than a non leap-year.
  • a chronology that does not support the concept of a year must return false.
  • the correct result must be returned for all years within the valid range of years for the chronology.

Outside the range of valid years an implementation is free to return either a best guess or false. An implementation must not throw an exception, even if the year is outside the range of valid years.

ChronoLocalDateTime<out ChronoLocalDate!>! localDateTime(temporal: TemporalAccessor!)

Obtains a local date-time in this chronology from another temporal object.

This obtains a date-time in this chronology based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ChronoLocalDateTime.

The conversion extracts and combines the ChronoLocalDate and the LocalTime from the temporal object. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects. The result uses this chronology.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, aChronology::localDateTime.

ChronoPeriod! period(years: Int, months: Int, days: Int)

Obtains a period for this chronology based on years, months and days.

This returns a period tied to this chronology using the specified years, months and days. All supplied chronologies use periods based on years, months and days, however the ChronoPeriod API allows the period to be represented using other units.

Int prolepticYear(era: Era!, yearOfEra: Int)

Calculates the proleptic-year given the era and year-of-era.

This combines the era and year-of-era into the single proleptic-year field.

If the chronology makes active use of eras, such as JapaneseChronology then the year-of-era will be validated against the era. For other chronologies, validation is optional.

ValueRange! range(field: ChronoField!)

Gets the range of valid values for the specified field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value.

Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

This method will return a result whether or not the chronology supports the field.

ChronoZonedDateTime<out ChronoLocalDate!>! zonedDateTime(instant: Instant!, zone: ZoneId!)

Obtains a ChronoZonedDateTime in this chronology from an Instant.

This obtains a zoned date-time with the same instant as that specified.

ChronoZonedDateTime<out ChronoLocalDate!>! zonedDateTime(temporal: TemporalAccessor!)

Obtains a ChronoZonedDateTime in this chronology from another temporal object.

This obtains a zoned date-time in this chronology based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ChronoZonedDateTime.

The conversion will first obtain a ZoneId from the temporal object, falling back to a ZoneOffset if necessary. It will then try to obtain an Instant, falling back to a ChronoLocalDateTime if necessary. The result will be either the combination of ZoneId or ZoneOffset with Instant or ChronoLocalDateTime. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects. The result uses this chronology.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, aChronology::zonedDateTime.

Properties
static HijrahChronology!

Singleton instance of the Islamic Umm Al-Qura calendar of Saudi Arabia.

Public methods

date

Added in API level 26
fun date(
    prolepticYear: Int,
    month: Int,
    dayOfMonth: Int
): HijrahDate!

Obtains a local date in Hijrah calendar system from the proleptic-year, month-of-year and day-of-month fields.

Parameters
prolepticYear Int: the proleptic-year
month Int: the month-of-year
dayOfMonth Int: the day-of-month
Return
HijrahDate! the Hijrah local date, not null
Exceptions
java.time.DateTimeException if unable to create the date

date

Added in API level 26
fun date(
    era: Era!,
    yearOfEra: Int,
    month: Int,
    dayOfMonth: Int
): HijrahDate!

Obtains a local date in Hijrah calendar system from the era, year-of-era, month-of-year and day-of-month fields.

Parameters
era Era!: the Hijrah era, not null
yearOfEra Int: the year-of-era
month Int: the month-of-year
dayOfMonth Int: the day-of-month
Return
HijrahDate! the Hijrah local date, not null
Exceptions
java.time.DateTimeException if unable to create the date
java.lang.ClassCastException if the era is not a HijrahEra

date

Added in API level 26
fun date(temporal: TemporalAccessor!): HijrahDate!
Parameters
temporal TemporalAccessor!: the temporal object to convert, not null
Return
HijrahDate! the local date in this chronology, not null
Exceptions
java.time.DateTimeException if unable to create the date

dateEpochDay

Added in API level 26
fun dateEpochDay(epochDay: Long): HijrahDate!

Obtains a local date in the Hijrah calendar system from the epoch-day.

Parameters
epochDay Long: the epoch day
Return
HijrahDate! the Hijrah local date, not null
Exceptions
java.time.DateTimeException if unable to create the date

dateNow

Added in API level 26
fun dateNow(): HijrahDate!
Return
HijrahDate! the current local date using the system clock and default time-zone, not null
Exceptions
java.time.DateTimeException if unable to create the date

dateNow

Added in API level 26
fun dateNow(clock: Clock!): HijrahDate!
Parameters
clock Clock!: the clock to use, not null
Return
HijrahDate! the current local date, not null
Exceptions
java.time.DateTimeException if unable to create the date

dateNow

Added in API level 26
fun dateNow(zone: ZoneId!): HijrahDate!
Parameters
zone ZoneId!: the zone ID to use, not null
Return
HijrahDate! the current local date using the system clock, not null
Exceptions
java.time.DateTimeException if unable to create the date

dateYearDay

Added in API level 26
fun dateYearDay(
    prolepticYear: Int,
    dayOfYear: Int
): HijrahDate!

Obtains a local date in Hijrah calendar system from the proleptic-year and day-of-year fields.

Parameters
prolepticYear Int: the proleptic-year
dayOfYear Int: the day-of-year
Return
HijrahDate! the Hijrah local date, not null
Exceptions
java.time.DateTimeException if the value of the year is out of range, or if the day-of-year is invalid for the year

dateYearDay

Added in API level 26
fun dateYearDay(
    era: Era!,
    yearOfEra: Int,
    dayOfYear: Int
): HijrahDate!

Obtains a local date in Hijrah calendar system from the era, year-of-era and day-of-year fields.

Parameters
era Era!: the Hijrah era, not null
yearOfEra Int: the year-of-era
dayOfYear Int: the day-of-year
Return
HijrahDate! the Hijrah local date, not null
Exceptions
java.time.DateTimeException if unable to create the date
java.lang.ClassCastException if the era is not a HijrahEra

eraOf

Added in API level 26
fun eraOf(eraValue: Int): HijrahEra!

Creates the HijrahEra object from the numeric value. The Hijrah calendar system has only one era covering the proleptic years greater than zero. This method returns the singleton HijrahEra for the value 1.

Parameters
eraValue Int: the era value
Return
HijrahEra! the calendar system era, not null
Exceptions
java.time.DateTimeException if unable to create the era

eras

Added in API level 26
fun eras(): MutableList<Era!>!
Return
MutableList<Era!>! the list of eras for the chronology, may be immutable, not null

getCalendarType

Added in API level 26
fun getCalendarType(): String!

Gets the calendar type of the Islamic calendar.

The calendar type is an identifier defined by the Unicode Locale Data Markup Language (LDML) specification. It can be used to lookup the Chronology using Chronology.of(String).

Return
String! the calendar system type; non-null if the calendar has a standard type, otherwise null

See Also

getId

Added in API level 26
fun getId(): String!

Gets the ID of the chronology.

The ID uniquely identifies the Chronology. It can be used to lookup the Chronology using Chronology.of(String).

Return
String! the chronology ID, non-null

isLeapYear

Added in API level 26
fun isLeapYear(prolepticYear: Long): Boolean
Parameters
prolepticYear Long: the proleptic-year to check, not validated for range
Return
Boolean true if the year is a leap year

localDateTime

Added in API level 26
fun localDateTime(temporal: TemporalAccessor!): ChronoLocalDateTime<HijrahDate!>!
Parameters
temporal TemporalAccessor!: the temporal object to convert, not null
Return
ChronoLocalDateTime<HijrahDate!>! the local date-time in this chronology, not null
Exceptions
java.time.DateTimeException if unable to create the date-time

prolepticYear

Added in API level 26
fun prolepticYear(
    era: Era!,
    yearOfEra: Int
): Int
Parameters
era Era!: the era of the correct type for the chronology, not null
yearOfEra Int: the chronology year-of-era
Return
Int the proleptic-year
Exceptions
java.time.DateTimeException if unable to convert to a proleptic-year, such as if the year is invalid for the era
java.lang.ClassCastException if the era is not of the correct type for the chronology

range

Added in API level 26
fun range(field: ChronoField!): ValueRange!
Parameters
field ChronoField!: the field to get the range for, not null
Return
ValueRange! the range of valid values for the field, not null
Exceptions
java.time.DateTimeException if the range for the field cannot be obtained

resolveDate

Added in API level 26
fun resolveDate(
    fieldValues: MutableMap<TemporalField!, Long!>!,
    resolverStyle: ResolverStyle!
): HijrahDate!
Parameters
fieldValues MutableMap<TemporalField!, Long!>!: the map of fields to values, which can be updated, not null
resolverStyle ResolverStyle!: the requested type of resolve, not null
Return
HijrahDate! the resolved date, null if insufficient information to create a date
Exceptions
java.time.DateTimeException if the date cannot be resolved, typically because of a conflict in the input data

zonedDateTime

Added in API level 26
fun zonedDateTime(
    instant: Instant!,
    zone: ZoneId!
): ChronoZonedDateTime<HijrahDate!>!
Parameters
instant Instant!: the instant to create the date-time from, not null
zone ZoneId!: the time-zone, not null
Return
ChronoZonedDateTime<HijrahDate!>! the zoned date-time, not null
Exceptions
java.time.DateTimeException if the result exceeds the supported range

zonedDateTime

Added in API level 26
fun zonedDateTime(temporal: TemporalAccessor!): ChronoZonedDateTime<HijrahDate!>!
Parameters
temporal TemporalAccessor!: the temporal object to convert, not null
Return
ChronoZonedDateTime<HijrahDate!>! the zoned date-time in this chronology, not null
Exceptions
java.time.DateTimeException if unable to create the date-time

Properties

INSTANCE

Added in API level 26
static val INSTANCE: HijrahChronology!

Singleton instance of the Islamic Umm Al-Qura calendar of Saudi Arabia. Other Hijrah chronology variants may be available from Chronology.getAvailableChronologies.