HijrahChronology
class HijrahChronology : AbstractChronology, Serializable
| kotlin.Any | ||
| ↳ | java.time.chrono.AbstractChronology | |
| ↳ | java.time.chrono.HijrahChronology | |
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:
| 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! |
Obtains a local date in Hijrah calendar system from the proleptic-year, month-of-year and day-of-month fields. |
| HijrahDate! |
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!)Obtains a local date in this chronology from another temporal object. |
| HijrahDate! |
dateEpochDay(epochDay: Long)Obtains a local date in the Hijrah calendar system from the epoch-day. |
| HijrahDate! |
dateNow()Obtains the current local date in this chronology from the system clock in the default time-zone. |
| HijrahDate! |
Obtains the current local date in this chronology from the specified clock. |
| HijrahDate! |
Obtains the current local date in this chronology from the system clock in the specified time-zone. |
| 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! |
Creates the HijrahEra object from the numeric value. |
| MutableList<Era!>! |
eras()Gets the list of eras for the chronology. |
| String! |
Gets the calendar type of the Islamic calendar. |
| String! |
getId()Gets the ID of the chronology. |
| Boolean |
isLeapYear(prolepticYear: Long)Checks if the specified year is a leap year. |
| ChronoLocalDateTime<HijrahDate!>! |
localDateTime(temporal: TemporalAccessor!)Obtains a local date-time in this chronology from another temporal object. |
| Int |
prolepticYear(era: Era!, yearOfEra: Int)Calculates the proleptic-year given the era and year-of-era. |
| ValueRange! |
range(field: ChronoField!)Gets the range of valid values for the specified field. |
| HijrahDate! |
resolveDate(fieldValues: MutableMap<TemporalField!, Long!>!, resolverStyle: ResolverStyle!)Resolves parsed |
| ChronoZonedDateTime<HijrahDate!>! |
zonedDateTime(instant: Instant!, zone: ZoneId!)Obtains a |
| ChronoZonedDateTime<HijrahDate!>! |
zonedDateTime(temporal: TemporalAccessor!)Obtains a |
| Inherited functions | |
|---|---|
| Properties | |
|---|---|
| static HijrahChronology! |
Singleton instance of the Islamic Umm Al-Qura calendar of Saudi Arabia. |
Public methods
date
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
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.lang.ClassCastException |
if the era is not a HijrahEra |
java.time.DateTimeException |
if unable to create the date |
date
fun date(temporal: TemporalAccessor!): HijrahDate!
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.
| 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
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
fun dateNow(): HijrahDate!
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.
| 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
fun dateNow(clock: Clock!): HijrahDate!
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.
| 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
fun dateNow(zone: ZoneId!): HijrahDate!
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.
| 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
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
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.lang.ClassCastException |
if the era is not a HijrahEra |
java.time.DateTimeException |
if unable to create the date |
eraOf
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
fun eras(): MutableList<Era!>!
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.
| Return | |
|---|---|
MutableList<Era!>! |
the list of eras for the chronology, may be immutable, not null |
getCalendarType
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
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 |
See Also
isLeapYear
fun isLeapYear(prolepticYear: Long): Boolean
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.
| Parameters | |
|---|---|
prolepticYear |
Long: the proleptic-year to check, not validated for range |
| Return | |
|---|---|
Boolean |
true if the year is a leap year |
localDateTime
fun localDateTime(temporal: TemporalAccessor!): ChronoLocalDateTime<HijrahDate!>!
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.
| 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
fun prolepticYear(
era: Era!,
yearOfEra: Int
): 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.
| 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.lang.ClassCastException |
if the era is not of the correct type for the chronology |
java.time.DateTimeException |
if unable to convert to a proleptic-year, such as if the year is invalid for the era |
range
fun range(field: ChronoField!): ValueRange!
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.
| 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
fun resolveDate(
fieldValues: MutableMap<TemporalField!, Long!>!,
resolverStyle: ResolverStyle!
): HijrahDate!
Resolves parsed ChronoField values into a date during parsing.
Most TemporalField implementations are resolved using the resolve method on the field. By contrast, the ChronoField class defines fields that only have meaning relative to the chronology. As such, ChronoField date fields are resolved here in the context of a specific chronology.
ChronoField instances are resolved by this method, which may be overridden in subclasses.
EPOCH_DAY- If present, this is converted to a date and all other date fields are then cross-checked against the date.PROLEPTIC_MONTH- If present, then it is split into theYEARandMONTH_OF_YEAR. If the mode is strict or smart then the field is validated.YEAR_OF_ERAandERA- If both are present, then they are combined to form aYEAR. In lenient mode, theYEAR_OF_ERArange is not validated, in smart and strict mode it is. TheERAis validated for range in all three modes. If only theYEAR_OF_ERAis present, and the mode is smart or lenient, then the last available era is assumed. In strict mode, no era is assumed and theYEAR_OF_ERAis left untouched. If only theERAis present, then it is left untouched.YEAR,MONTH_OF_YEARandDAY_OF_MONTH- If all three are present, then they are combined to form a date. In all three modes, theYEARis validated. If the mode is smart or strict, then the month and day are validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the first month in the requested year, then adding the difference in months, then the difference in days. If the mode is smart, and the day-of-month is greater than the maximum for the year-month, then the day-of-month is adjusted to the last day-of-month. If the mode is strict, then the three fields must form a valid date.YEARandDAY_OF_YEAR- If both are present, then they are combined to form a date. In all three modes, theYEARis validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the requested year, then adding the difference in days. If the mode is smart or strict, then the two fields must form a valid date.YEAR,MONTH_OF_YEAR,ALIGNED_WEEK_OF_MONTHandALIGNED_DAY_OF_WEEK_IN_MONTH- If all four are present, then they are combined to form a date. In all three modes, theYEARis validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the first month in the requested year, then adding the difference in months, then the difference in weeks, then in days. If the mode is smart or strict, then the all four fields are validated to their outer ranges. The date is then combined in a manner equivalent to creating a date on the first day of the requested year and month, then adding the amount in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the month.YEAR,MONTH_OF_YEAR,ALIGNED_WEEK_OF_MONTHandDAY_OF_WEEK- If all four are present, then they are combined to form a date. The approach is the same as described above for years, months and weeks inALIGNED_DAY_OF_WEEK_IN_MONTH. The day-of-week is adjusted as the next or same matching day-of-week once the years, months and weeks have been handled.YEAR,ALIGNED_WEEK_OF_YEARandALIGNED_DAY_OF_WEEK_IN_YEAR- If all three are present, then they are combined to form a date. In all three modes, theYEARis validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the requested year, then adding the difference in weeks, then in days. If the mode is smart or strict, then the all three fields are validated to their outer ranges. The date is then combined in a manner equivalent to creating a date on the first day of the requested year, then adding the amount in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the year.YEAR,ALIGNED_WEEK_OF_YEARandDAY_OF_WEEK- If all three are present, then they are combined to form a date. The approach is the same as described above for years and weeks inALIGNED_DAY_OF_WEEK_IN_YEAR. The day-of-week is adjusted as the next or same matching day-of-week once the years and weeks have been handled.
The default implementation is suitable for most calendar systems. If java.time.temporal.ChronoField#YEAR_OF_ERA is found without an java.time.temporal.ChronoField#ERA then the last era in eras() is used. The implementation assumes a 7 day week, that the first day-of-month has the value 1, that first day-of-year has the value 1, and that the first of the month and year always exists.
| 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
fun zonedDateTime(
instant: Instant!,
zone: ZoneId!
): ChronoZonedDateTime<HijrahDate!>!
Obtains a ChronoZonedDateTime in this chronology from an Instant.
This obtains a zoned date-time with the same instant as that specified.
| 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
fun zonedDateTime(temporal: TemporalAccessor!): ChronoZonedDateTime<HijrahDate!>!
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.
| 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
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.