HijrahChronology
public
final
class
HijrahChronology
extends AbstractChronology
implements
Serializable
| java.lang.Object | ||
| ↳ | 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 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
Fields | |
|---|---|
public
static
final
HijrahChronology |
INSTANCE
Singleton instance of the Islamic Umm Al-Qura calendar of Saudi Arabia. |
Public methods | |
|---|---|
HijrahDate
|
date(int prolepticYear, int month, int dayOfMonth)
Obtains a local date in Hijrah calendar system from the proleptic-year, month-of-year and day-of-month fields. |
HijrahDate
|
date(Era era, int yearOfEra, int month, int dayOfMonth)
Obtains a local date in Hijrah calendar system from the era, year-of-era, month-of-year and day-of-month fields. |
HijrahDate
|
date(TemporalAccessor temporal)
|
HijrahDate
|
dateEpochDay(long epochDay)
Obtains a local date in the Hijrah calendar system from the epoch-day. |
HijrahDate
|
dateNow(ZoneId zone)
|
HijrahDate
|
dateNow()
|
HijrahDate
|
dateNow(Clock clock)
|
HijrahDate
|
dateYearDay(Era era, int yearOfEra, int dayOfYear)
Obtains a local date in Hijrah calendar system from the era, year-of-era and day-of-year fields. |
HijrahDate
|
dateYearDay(int prolepticYear, int dayOfYear)
Obtains a local date in Hijrah calendar system from the proleptic-year and day-of-year fields. |
HijrahEra
|
eraOf(int eraValue)
Creates the HijrahEra object from the numeric value. |
List<Era>
|
eras()
|
String
|
getCalendarType()
Gets the calendar type of the Islamic calendar. |
String
|
getId()
Gets the ID of the chronology. |
boolean
|
isLeapYear(long prolepticYear)
|
ChronoLocalDateTime<HijrahDate>
|
localDateTime(TemporalAccessor temporal)
|
int
|
prolepticYear(Era era, int yearOfEra)
|
ValueRange
|
range(ChronoField field)
|
HijrahDate
|
resolveDate(Map<TemporalField, Long> fieldValues, ResolverStyle resolverStyle)
Resolves parsed |
ChronoZonedDateTime<HijrahDate>
|
zonedDateTime(TemporalAccessor temporal)
|
ChronoZonedDateTime<HijrahDate>
|
zonedDateTime(Instant instant, ZoneId zone)
|
Inherited methods | |
|---|---|
Fields
INSTANCE
public static final HijrahChronology INSTANCE
Singleton instance of the Islamic Umm Al-Qura calendar of Saudi Arabia.
Other Hijrah chronology variants may be available from
Chronology.getAvailableChronologies.
Public methods
date
public HijrahDate date (int prolepticYear, int month, int dayOfMonth)
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 |
| Returns | |
|---|---|
HijrahDate |
the Hijrah local date, not null |
| Throws | |
|---|---|
DateTimeException |
if unable to create the date |
date
public HijrahDate date (Era era, int yearOfEra, int month, int dayOfMonth)
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 |
| Returns | |
|---|---|
HijrahDate |
the Hijrah local date, not null |
| Throws | |
|---|---|
ClassCastException |
if the era is not a HijrahEra |
DateTimeException |
if unable to create the date |
date
public HijrahDate date (TemporalAccessor temporal)
| Parameters | |
|---|---|
temporal |
TemporalAccessor |
| Returns | |
|---|---|
HijrahDate |
|
dateEpochDay
public HijrahDate dateEpochDay (long epochDay)
Obtains a local date in the Hijrah calendar system from the epoch-day.
| Parameters | |
|---|---|
epochDay |
long: the epoch day |
| Returns | |
|---|---|
HijrahDate |
the Hijrah local date, not null |
| Throws | |
|---|---|
DateTimeException |
if unable to create the date |
dateNow
public HijrahDate dateNow (ZoneId zone)
| Parameters | |
|---|---|
zone |
ZoneId |
| Returns | |
|---|---|
HijrahDate |
|
dateNow
public HijrahDate dateNow (Clock clock)
| Parameters | |
|---|---|
clock |
Clock |
| Returns | |
|---|---|
HijrahDate |
|
dateYearDay
public HijrahDate dateYearDay (Era era, int yearOfEra, int dayOfYear)
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 |
| Returns | |
|---|---|
HijrahDate |
the Hijrah local date, not null |
| Throws | |
|---|---|
ClassCastException |
if the era is not a HijrahEra |
DateTimeException |
if unable to create the date |
dateYearDay
public HijrahDate dateYearDay (int prolepticYear, int dayOfYear)
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 |
| Returns | |
|---|---|
HijrahDate |
the Hijrah local date, not null |
| Throws | |
|---|---|
DateTimeException |
if the value of the year is out of range, or if the day-of-year is invalid for the year |
eraOf
public HijrahEra eraOf (int eraValue)
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 |
| Returns | |
|---|---|
HijrahEra |
the calendar system era, not null |
| Throws | |
|---|---|
DateTimeException |
if unable to create the era |
getCalendarType
public String getCalendarType ()
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).
| Returns | |
|---|---|
String |
the calendar system type; non-null if the calendar has a standard type, otherwise null |
See also:
getId
public String getId ()
Gets the ID of the chronology.
The ID uniquely identifies the Chronology. It can be used to
lookup the Chronology using Chronology.of(String).
| Returns | |
|---|---|
String |
the chronology ID, non-null |
See also:
isLeapYear
public boolean isLeapYear (long prolepticYear)
| Parameters | |
|---|---|
prolepticYear |
long |
| Returns | |
|---|---|
boolean |
|
localDateTime
public ChronoLocalDateTime<HijrahDate> localDateTime (TemporalAccessor temporal)
| Parameters | |
|---|---|
temporal |
TemporalAccessor |
| Returns | |
|---|---|
ChronoLocalDateTime<HijrahDate> |
|
prolepticYear
public int prolepticYear (Era era, int yearOfEra)
| Parameters | |
|---|---|
era |
Era |
yearOfEra |
int |
| Returns | |
|---|---|
int |
|
range
public ValueRange range (ChronoField field)
| Parameters | |
|---|---|
field |
ChronoField |
| Returns | |
|---|---|
ValueRange |
|
resolveDate
public HijrahDate resolveDate (Map<TemporalField, Long> fieldValues, ResolverStyle resolverStyle)
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 ChronoField.YEAR_OF_ERA is found without an ChronoField.ERA
then the last era in Chronology.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 |
Map: the map of fields to values, which can be updated, not null |
resolverStyle |
ResolverStyle: the requested type of resolve, not null |
| Returns | |
|---|---|
HijrahDate |
the resolved date, null if insufficient information to create a date |
zonedDateTime
public ChronoZonedDateTime<HijrahDate> zonedDateTime (TemporalAccessor temporal)
| Parameters | |
|---|---|
temporal |
TemporalAccessor |
| Returns | |
|---|---|
ChronoZonedDateTime<HijrahDate> |
|
zonedDateTime
public ChronoZonedDateTime<HijrahDate> zonedDateTime (Instant instant, ZoneId zone)
| Parameters | |
|---|---|
instant |
Instant |
zone |
ZoneId |
| Returns | |
|---|---|
ChronoZonedDateTime<HijrahDate> |
|