org.threeten.bp.chrono.Chronology
org.threeten.bp.chrono.HijrahChronology
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public final class HijrahChronology
The Hijrah calendar system.
This chronology defines the rules of the Hijrah calendar system.
The implementation follows the Freeman-Grenville algorithm (*1) and has following features.
The table shows the features described above.
# of month Name of month Number of days 1 Muharram 30 2 Safar 29 3 Rabi'al-Awwal 30 4 Rabi'ath-Thani 29 5 Jumada l-Ula 30 6 Jumada t-Tania 29 7 Rajab 30 8 Sha`ban 29 9 Ramadan 30 10 Shawwal 29 11 Dhu 'l-Qa`da 30 12 Dhu 'l-Hijja 29, but 30 days in years 2, 5, 7, 10,
13, 16, 18, 21, 24, 26, and 29
(*1) The algorithm is taken from the book, The Muslim and Christian Calendars by G.S.P. Freeman-Grenville.
| Field Summary | |
|---|---|
static HijrahChronology |
INSTANCE
Singleton instance of the Hijrah chronology. |
| Fields inherited from class org.threeten.bp.chrono.Chronology |
|---|
FROM |
| Method Summary | |
|---|---|
HijrahDate |
date(Era era,
int yearOfEra,
int month,
int dayOfMonth)
Obtains a local date in this chronology from the era, year-of-era, month-of-year and day-of-month fields. |
HijrahDate |
date(int prolepticYear,
int month,
int dayOfMonth)
Obtains a local date in this chronology from the proleptic-year, month-of-year and day-of-month fields. |
HijrahDate |
date(TemporalAccessor temporal)
Obtains a local date in this chronology from another temporal object. |
HijrahDate |
dateEpochDay(long epochDay)
Obtains a local date in this chronology from the epoch-day. |
HijrahDate |
dateNow()
Obtains the current local date in this chronology from the system clock in the default time-zone. |
HijrahDate |
dateNow(Clock clock)
Obtains the current local date in this chronology from the specified clock. |
HijrahDate |
dateNow(ZoneId zone)
Obtains the current local date in this chronology from the system clock in the specified time-zone. |
HijrahDate |
dateYearDay(Era era,
int yearOfEra,
int dayOfYear)
Obtains a local date in this chronology from the era, year-of-era and day-of-year fields. |
HijrahDate |
dateYearDay(int prolepticYear,
int dayOfYear)
Obtains a local date in this chronology from the proleptic-year and day-of-year fields. |
HijrahEra |
eraOf(int eraValue)
Creates the chronology era object from the numeric value. |
List<Era> |
eras()
Gets the list of eras for the chronology. |
String |
getCalendarType()
Gets the calendar type of the underlying calendar system - 'islamic-umalqura'. |
String |
getId()
Gets the ID of the chronology - 'Hijrah-umalqura'. |
boolean |
isLeapYear(long prolepticYear)
Checks if the specified year is a leap year. |
ChronoLocalDateTime<HijrahDate> |
localDateTime(TemporalAccessor temporal)
Obtains a local date-time in this chronology from another temporal object. |
int |
prolepticYear(Era era,
int yearOfEra)
Calculates the proleptic-year given the era and year-of-era. |
ValueRange |
range(ChronoField field)
Gets the range of valid values for the specified field. |
HijrahDate |
resolveDate(Map<TemporalField,Long> fieldValues,
ResolverStyle resolverStyle)
Resolves parsed ChronoField values into a date during parsing. |
ChronoZonedDateTime<HijrahDate> |
zonedDateTime(Instant instant,
ZoneId zone)
Obtains a zoned date-time in this chronology from an Instant. |
ChronoZonedDateTime<HijrahDate> |
zonedDateTime(TemporalAccessor temporal)
Obtains a zoned date-time in this chronology from another temporal object. |
| Methods inherited from class org.threeten.bp.chrono.Chronology |
|---|
compareTo, equals, from, getAvailableChronologies, getDisplayName, hashCode, of, ofLocale, period, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final HijrahChronology INSTANCE
| Method Detail |
|---|
public String getId()
The ID uniquely identifies the Chronology.
It can be used to lookup the Chronology using Chronology.of(String).
getId in class ChronologygetCalendarType()public String getCalendarType()
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).
It can also be used as part of a locale, accessible via
Locale#getUnicodeLocaleType(String) with the key 'ca'.
getCalendarType in class ChronologygetId()
public HijrahDate date(Era era,
int yearOfEra,
int month,
int dayOfMonth)
Chronology
date in class Chronologyera - the era of the correct type for the chronology, not nullyearOfEra - the chronology year-of-eramonth - the chronology month-of-yeardayOfMonth - the chronology day-of-month
public HijrahDate date(int prolepticYear,
int month,
int dayOfMonth)
Chronology
date in class ChronologyprolepticYear - the chronology proleptic-yearmonth - the chronology month-of-yeardayOfMonth - the chronology day-of-month
public HijrahDate dateYearDay(Era era,
int yearOfEra,
int dayOfYear)
Chronology
dateYearDay in class Chronologyera - the era of the correct type for the chronology, not nullyearOfEra - the chronology year-of-eradayOfYear - the chronology day-of-year
public HijrahDate dateYearDay(int prolepticYear,
int dayOfYear)
Chronology
dateYearDay in class ChronologyprolepticYear - the chronology proleptic-yeardayOfYear - the chronology day-of-year
public HijrahDate dateEpochDay(long epochDay)
Chronology
The definition of EPOCH_DAY is the same
for all calendar systems, thus it can be used for conversion.
dateEpochDay in class ChronologyepochDay - the epoch day
public HijrahDate date(TemporalAccessor temporal)
Chronology
This creates a date in this chronology based on the specified TemporalAccessor.
The standard mechanism for conversion between date types is the
local epoch-day field.
date in class Chronologytemporal - the temporal object to convert, not null
public ChronoLocalDateTime<HijrahDate> localDateTime(TemporalAccessor temporal)
Chronology
This creates a date-time in this chronology based on the specified TemporalAccessor.
The date of the date-time should be equivalent to that obtained by calling
Chronology.date(TemporalAccessor).
The standard mechanism for conversion between time types is the
nano-of-day field.
localDateTime in class Chronologytemporal - the temporal object to convert, not null
public ChronoZonedDateTime<HijrahDate> zonedDateTime(TemporalAccessor temporal)
Chronology
This creates a date-time in this chronology based on the specified TemporalAccessor.
This should obtain a ZoneId using ZoneId.from(TemporalAccessor).
The date-time should be obtained by obtaining an Instant.
If that fails, the local date-time should be used.
zonedDateTime in class Chronologytemporal - the temporal object to convert, not null
public ChronoZonedDateTime<HijrahDate> zonedDateTime(Instant instant,
ZoneId zone)
ChronologyInstant.
This creates a zoned date-time with the same instant as that specified.
zonedDateTime in class Chronologyinstant - the instant to create the date-time from, not nullzone - the time-zone, not null
public HijrahDate dateNow()
Chronology
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.
This implementation uses Chronology.dateNow(Clock).
dateNow in class Chronologypublic HijrahDate dateNow(ZoneId zone)
Chronology
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.
dateNow in class Chronologyzone - the zone ID to use, not null
public HijrahDate dateNow(Clock clock)
Chronology
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.
dateNow in class Chronologyclock - the clock to use, not null
public boolean isLeapYear(long prolepticYear)
ChronologyA leap-year is a year of a longer length than normal. The exact meaning is determined by the chronology according to the following constraints.
isLeapYear in class ChronologyprolepticYear - the proleptic-year to check, not validated for range
public int prolepticYear(Era era,
int yearOfEra)
ChronologyThis combines the era and year-of-era into the single proleptic-year field.
prolepticYear in class Chronologyera - the era of the correct type for the chronology, not nullyearOfEra - the chronology year-of-era
public HijrahEra eraOf(int eraValue)
ChronologyThe 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.
eraOf in class ChronologyeraValue - the era value
public List<Era> eras()
ChronologyMost 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.
eras in class Chronologypublic ValueRange range(ChronoField field)
Chronology
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.
range in class Chronologyfield - the field to get the range for, not null
public HijrahDate resolveDate(Map<TemporalField,Long> fieldValues,
ResolverStyle resolverStyle)
ChronologyChronoField 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.
The default implementation, which explains typical resolve behaviour,
is provided in AbstractChronology.
resolveDate in class ChronologyfieldValues - the map of fields to values, which can be updated, not nullresolverStyle - the requested type of resolve, not null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||