HijrahChrono (ThreeTen Date and Time API)

java.lang.Object
- java.time.temporal.Chrono<HijrahChrono>
- - java.time.calendar.HijrahChrono

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<Chrono<?>>

public final class HijrahChrono
extends Chrono<HijrahChrono>
implements java.io.Serializable

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.

A year has 12 months.
Over a cycle of 30 years there are 11 leap years.
There are 30 days in month number 1, 3, 5, 7, 9, and 11, and 29 days in month number 2, 4, 6, 8, 10, and 12.
In a leap year month 12 has 30 days.
In a 30 year cycle, year 2, 5, 7, 10, 13, 16, 18, 21, 24, 26, and 29 are leap years.
Total of 10631 days in a 30 years cycle.

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

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.

Specification for implementors

This class is immutable and thread-safe.

Since:: 1.8
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Era<HijrahChrono>`	`ERA_AH` The singleton instance for the current era - Hijrah - which has the value 1.
`static Era<HijrahChrono>`	`ERA_BEFORE_AH` The singleton instance for the era before the current one - Before Hijrah - which has the value 0.
`static HijrahChrono`	`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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChronoLocalDate<HijrahChrono>`	`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.
`ChronoLocalDate<HijrahChrono>`	`date(TemporalAccessor temporal)` Obtains a local date in this chronology from another temporal object.
`ChronoLocalDate<HijrahChrono>`	`dateYearDay(int prolepticYear, int dayOfYear)` Obtains a local date in this chronology from the proleptic-year and day-of-year fields.
`Era<HijrahChrono>`	`eraOf(int eraValue)` Creates the chronology era object from the numeric value.
`java.util.List<Era<HijrahChrono>>`	`eras()` Gets the list of eras for the chronology.
`java.lang.String`	`getCalendarType()` Gets the calendar type of the underlying calendar system - 'islamicc'.
`java.lang.String`	`getId()` Gets the ID of the chronology - 'Hijrah'.
`boolean`	`isLeapYear(long prolepticYear)` Checks if the specified year is a leap year.
`int`	`prolepticYear(Era<HijrahChrono> 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.

Methods inherited from class java.time.temporal.Chrono
compareTo, date, dateNow, dateNow, dateNow, dateTime, dateYearDay, equals, from, getAvailableChronologies, getText, hashCode, localDateTime, of, ofLocale, toString, zonedDateTime, zonedDateTime

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERA_BEFORE_AH
```
public static final Era<HijrahChrono> ERA_BEFORE_AH
```
    The singleton instance for the era before the current one - Before Hijrah - which has the value 0.
  - ERA_AH
```
public static final Era<HijrahChrono> ERA_AH
```
    The singleton instance for the current era - Hijrah - which has the value 1.
  - MIN_YEAR_OF_ERA
```
public static final int MIN_YEAR_OF_ERA
```
    The minimum valid year-of-era.
    
    See Also:
    Constant Field Values
  - MAX_YEAR_OF_ERA
```
public static final int MAX_YEAR_OF_ERA
```
    The maximum valid year-of-era. This is currently set to 9999 but may be changed to increase the valid range in a future version of the specification.
    
    See Also:
    Constant Field Values
  - INSTANCE
```
public static final HijrahChrono INSTANCE
```
    Singleton instance of the Hijrah chronology. Must be initialized after the rest of the static initialization.
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Gets the ID of the chronology - 'Hijrah'.
    The ID uniquely identifies the Chrono. It can be used to lookup the Chrono using Chrono.of(String).
    
    Specified by:
    
    getId in class Chrono<HijrahChrono>
    
    Returns:
    the chronology ID - 'Hijrah'
    See Also:
    getCalendarType()
  - getCalendarType
```
public java.lang.String getCalendarType()
```
    Gets the calendar type of the underlying calendar system - 'islamicc'.
    The calendar type is an identifier defined by the Unicode Locale Data Markup Language (LDML) specification. It can be used to lookup the Chrono using Chrono.of(String). It can also be used as part of a locale, accessible via Locale.getUnicodeLocaleType(String) with the key 'ca'.
    
    Specified by:
    
    getCalendarType in class Chrono<HijrahChrono>
    
    Returns:
    the calendar system type - 'islamicc'
    See Also:
    getId()
  - date
```
public ChronoLocalDate<HijrahChrono> date(int prolepticYear,
                                 int month,
                                 int dayOfMonth)
```
    Description copied from class: Chrono
    
    Obtains a local date in this chronology from the proleptic-year, month-of-year and day-of-month fields.
    
    Specified by:
    
    date in class Chrono<HijrahChrono>
    
    Parameters:
    prolepticYear - the chronology proleptic-year
    month - the chronology month-of-year
    dayOfMonth - the chronology day-of-month
    
    Returns:
    the local date in this chronology, not null
  - dateYearDay
```
public ChronoLocalDate<HijrahChrono> dateYearDay(int prolepticYear,
                                        int dayOfYear)
```
    Description copied from class: Chrono
    
    Obtains a local date in this chronology from the proleptic-year and day-of-year fields.
    
    Specified by:
    
    dateYearDay in class Chrono<HijrahChrono>
    
    Parameters:
    prolepticYear - the chronology proleptic-year
    dayOfYear - the chronology day-of-year
    
    Returns:
    the local date in this chronology, not null
  - date
```
public ChronoLocalDate<HijrahChrono> date(TemporalAccessor temporal)
```
    Description copied from class: Chrono
    
    Obtains a local date in this chronology from another temporal object.
    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.
    
    Specified by:
    
    date in class Chrono<HijrahChrono>
    
    Parameters:
    temporal - the temporal object to convert, not null
    
    Returns:
    the local date in this chronology, not null
  - isLeapYear
```
public boolean isLeapYear(long prolepticYear)
```
    Description copied from class: Chrono
    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.
    Specified by:
    
    isLeapYear in class Chrono<HijrahChrono>
    
    Parameters:
    prolepticYear - the proleptic-year to check, not validated for range
    
    Returns:
    true if the year is a leap year
  - prolepticYear
```
public int prolepticYear(Era<HijrahChrono> era,
                int yearOfEra)
```
    Description copied from class: Chrono
    
    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.
    
    Specified by:
    
    prolepticYear in class Chrono<HijrahChrono>
    
    Parameters:
    era - the era of the correct type for the chronology, not null
    yearOfEra - the chronology year-of-era
    
    Returns:
    the proleptic-year
  - eraOf
```
public Era<HijrahChrono> eraOf(int eraValue)
```
    Description copied from class: Chrono
    
    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.
    
    Specified by:
    
    eraOf in class Chrono<HijrahChrono>
    
    Parameters:
    eraValue - the era value
    
    Returns:
    the calendar system era, not null
  - eras
```
public java.util.List<Era<HijrahChrono>> eras()
```
    Description copied from class: Chrono
    
    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.
    
    Specified by:
    
    eras in class Chrono<HijrahChrono>
    
    Returns:
    the list of eras for the chronology, may be immutable, not null
  - range
```
public ValueRange range(ChronoField field)
```
    Description copied from class: Chrono
    
    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.
    
    Specified by:
    
    range in class Chrono<HijrahChrono>
    
    Parameters:
    field - the field to get the range for, not null
    
    Returns:
    the range of valid values for the field, not null

Class HijrahChrono

Specification for implementors

Field Summary

Method Summary

Methods inherited from class java.time.temporal.Chrono

Methods inherited from class java.lang.Object

Field Detail

ERA_BEFORE_AH

ERA_AH

MIN_YEAR_OF_ERA

MAX_YEAR_OF_ERA

INSTANCE

Method Detail

getId

getCalendarType

date

dateYearDay

date

isLeapYear

prolepticYear

eraOf

eras

range