public final class HijrahChronology extends Chronology implements Serializable
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.
Hijrah Calendar Months # 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.
Modifier and Type | Field and Description |
---|---|
static Era |
ERA_AH
The singleton instance for the current era - Hijrah - which has the value 1.
|
static Era |
ERA_BEFORE_AH
The singleton instance for the era before the current one - Before Hijrah -
which has the value 0.
|
static HijrahChronology |
INSTANCE
Singleton instance of the Hijrah chronology.
|
static int |
MAX_YEAR_OF_ERA
The maximum valid year-of-era.
|
static int |
MIN_YEAR_OF_ERA
The minimum valid year-of-era.
|
Modifier and Type | Method and Description |
---|---|
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 |
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.
|
Era |
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 - 'islamicc'.
|
String |
getId()
Gets the ID of the chronology - 'Hijrah'.
|
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.
|
ChronoZonedDateTime<HijrahDate> |
zonedDateTime(Instant instant,
ZoneId zone)
Obtains a
ChronoZonedDateTime in this chronology from an Instant . |
ChronoZonedDateTime<HijrahDate> |
zonedDateTime(TemporalAccessor temporal)
Obtains a
ChronoZonedDateTime in this chronology from another temporal object. |
compareTo, equals, from, getAvailableChronologies, getDisplayName, hashCode, of, ofLocale, toString
public static final Era ERA_BEFORE_AH
public static final Era ERA_AH
public static final int MIN_YEAR_OF_ERA
public static final int MAX_YEAR_OF_ERA
public static final HijrahChronology INSTANCE
public String getId()
The ID uniquely identifies the Chronology
.
It can be used to lookup the Chronology
using Chronology.of(String)
.
getId
in class Chronology
getCalendarType()
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 Chronology
getId()
public HijrahDate date(int prolepticYear, int month, int dayOfMonth)
Chronology
date
in class Chronology
prolepticYear
- the chronology proleptic-yearmonth
- the chronology month-of-yeardayOfMonth
- the chronology day-of-monthpublic HijrahDate dateYearDay(int prolepticYear, int dayOfYear)
Chronology
dateYearDay
in class Chronology
prolepticYear
- the chronology proleptic-yeardayOfYear
- the chronology day-of-yearpublic HijrahDate date(TemporalAccessor temporal)
Chronology
This creates 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
.
date
in class Chronology
temporal
- the temporal object to convert, not nullpublic HijrahDate date(Era era, int yearOfEra, int month, int dayOfMonth)
Chronology
date
in class Chronology
era
- 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-monthpublic HijrahDate dateYearDay(Era era, int yearOfEra, int dayOfYear)
Chronology
dateYearDay
in class Chronology
era
- the era of the correct type for the chronology, not nullyearOfEra
- the chronology year-of-eradayOfYear
- the chronology day-of-yearpublic 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 Chronology
public 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 Chronology
zone
- the zone ID to use, not nullpublic 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 Chronology
clock
- the clock to use, not nullpublic ChronoLocalDateTime<HijrahDate> localDateTime(TemporalAccessor temporal)
Chronology
This creates 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
.
localDateTime
in class Chronology
temporal
- the temporal object to convert, not nullpublic ChronoZonedDateTime<HijrahDate> zonedDateTime(TemporalAccessor temporal)
Chronology
ChronoZonedDateTime
in this chronology from another temporal object.
This creates 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
.
zonedDateTime
in class Chronology
temporal
- the temporal object to convert, not nullpublic ChronoZonedDateTime<HijrahDate> zonedDateTime(Instant instant, ZoneId zone)
Chronology
ChronoZonedDateTime
in this chronology from an Instant
.
This creates a zoned date-time with the same instant as that specified.
zonedDateTime
in class Chronology
instant
- the instant to create the date-time from, not nullzone
- the time-zone, not nullpublic boolean isLeapYear(long prolepticYear)
Chronology
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.
isLeapYear
in class Chronology
prolepticYear
- the proleptic-year to check, not validated for rangepublic int prolepticYear(Era era, int yearOfEra)
Chronology
This combines the era and year-of-era into the single proleptic-year field.
prolepticYear
in class Chronology
era
- the era of the correct type for the chronology, not nullyearOfEra
- the chronology year-of-erapublic Era eraOf(int eraValue)
Chronology
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.
eraOf
in class Chronology
eraValue
- the era valuepublic List<Era> eras()
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.
eras
in class Chronology
public 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 Chronology
field
- the field to get the range for, not null Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT internal-0