HijriCalendar (time4j-android 3.28-2016j API)

java.lang.Object
- net.time4j.engine.ChronoEntity<D>
- - net.time4j.engine.CalendarVariant<HijriCalendar>
  - - net.time4j.calendar.HijriCalendar

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<HijriCalendar>, CalendarDate, ChronoDisplay, Temporal<CalendarDate>, LocalizedPatternSupport

@CalendarType(value="islamic")
public final class HijriCalendar
extends CalendarVariant<HijriCalendar>
implements LocalizedPatternSupport

Represents the Hijri calendar used in many islamic countries.

It is a lunar calendar which exists in several variants and is mainly for religious purposes. The variant used in Saudi-Arabia is named "islamic-umalqura" and is based on data partially observed by sighting the new moon, partially by astronomical calculations/predictions. Note that the religious authorities in most countries often publish dates which deviate from such official calendars by one or two days.

The calendar year is divided into 12 islamic months. Every month usually has either 29 or 30 days. The length of the month in days shall reflect the date when the new moon appears. However, for every variant there are different data or rules how to determine if a month has 29 or 30 days. The Hijri calendar day starts in the evening. New variants can be configured by a file named "{variant-name}.data" in the data-subdirectory of resource class path (where hyphens are replaced by underscores). Format details see the file "islamic_umalqura.data".

Following elements which are declared as constants are registered by this class:

Furthermore, all elements defined in EpochDays and CommonElements are supported.

Examples of usage:

     // parse a Hijri-string and convert to a gregorian date
     ChronoFormatter<HijriCalendar> formatter =
       ChronoFormatter.setUp(HijriCalendar.class, Locale.ENGLISH)
       .addPattern("EEE, d. MMMM yy", PatternType.NON_ISO_DATE).build()
       .withCalendarVariant(HijriCalendar.VARIANT_UMALQURA)
       .with(Attributes.PIVOT_YEAR, 1500); // mapped to range 1400-1499
     HijriCalendar hijri = formatter.parse("Thu, 29. Ramadan 36");
     PlainDate date = hijri.transform(PlainDate.class);
     System.out.println(date); // 2015-07-16

     // determine actual Hijri date (two methods)
     HijriCalendar today = // conversion valid at noon (not in the evening when next islamic day starts)
       SystemClock.inLocalView().today().transform(HijriCalendar.class, HijriCalendar.VARIANT_UMALQURA);
     HijriCalendar todayExact = // taking into account the specific start of day for Hijri calendar
       SystemClock.inLocalView().now(
         HijriCalendar.family(),
         HijriCalendar.VARIANT_UMALQURA,
         StartOfDay.EVENING // simple approximation => 18:00
       ).toDate();

Note that the supported range of this class is limited compared with the gregorian counter-example. Users can apply following code to determine the exact variant-dependent range:

     CalendarSystem<HijriCalendar> calsys =
       HijriCalendar.family().getCalendarSystem(HijriCalendar.VARIANT_UMALQURA);
     long min = calsys.getMinimumSinceUTC(); // -32556
     long max = calsys.getMaximumSinceUTC(); // 38671

     // same minimum and maximum displayed as Hijri calendar dates
     HijriCalendar minHijri = calsys.transform(min); // AH-1300-01-01[islamic-umalqura]
     HijriCalendar maxHijri = calsys.transform(max); // AH-1500-12-30[islamic-umalqura]

     // same minimum and maximum displayed as gregorian dates
     PlainDate minGregorian = PlainDate.of(min, EpochDays.UTC); // 1882-11-12
     PlainDate maxGregorian = PlainDate.of(max, EpochDays.UTC); // 2077-11-16

Since:: 3.5/4.3
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HijriCalendar.Unit
Defines come calendar units for the Hijri calendar.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HijriCalendar.Unit` Defines come calendar units for the Hijri calendar.

Field Summary

Fields
Modifier and Type	Field and Description
`static StdCalendarElement<java.lang.Integer,HijriCalendar>`	`DAY_OF_MONTH` Represents the islamic day of month.
`static StdCalendarElement<Weekday,HijriCalendar>`	`DAY_OF_WEEK` Represents the islamic day of week.
`static StdCalendarElement<java.lang.Integer,HijriCalendar>`	`DAY_OF_YEAR` Represents the islamic day of year.
`static ChronoElement<HijriEra>`	`ERA` Represents the islamic era.
`static StdCalendarElement<HijriMonth,HijriCalendar>`	`MONTH_OF_YEAR` Represents the islamic month.
`static java.lang.String`	`VARIANT_DIYANET` The name of the Turkish Diyanet-variant.
`static java.lang.String`	`VARIANT_ICU4J` The name of the astronomical ICU4J-variant.
`static java.lang.String`	`VARIANT_UMALQURA` The name of Umm-al-qura-variant.
`static StdCalendarElement<java.lang.Integer,HijriCalendar>`	`YEAR_OF_ERA` Represents the islamic year.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GeneralTimestamp<HijriCalendar>`	`at(PlainTime time)` Creates a new local timestamp with this date and given wall time.
`GeneralTimestamp<HijriCalendar>`	`atTime(int hour, int minute)` Is equivalent to `at(PlainTime.of(hour, minute))`.
`boolean`	`equals(java.lang.Object obj)` Compares the whole state of this instance with given object.
`static CalendarFamily<HijriCalendar>`	`family()` Returns the associated calendar family.
`int`	`getDayOfMonth()` Yields the islamic day of month.
`Weekday`	`getDayOfWeek()` Determines the day of week.
`int`	`getDayOfYear()` Yields the islamic day of year.
`static Weekmodel`	`getDefaultWeekmodel()` Obtains the standard week model of this calendar.
`HijriEra`	`getEra()` Yields the islamic era.
`HijriMonth`	`getMonth()` Yields the islamic month.
`java.lang.String`	`getVariant()` Returns the name of the associated variant of underlying calendar system.
`static java.lang.String`	`getVersion(java.lang.String variant)` Determines the data version of given variant.
`int`	`getYear()` Yields the islamic year.
`int`	`hashCode()` Subclasses must redefine this method corresponding to the behaviour of `equals()`.
`int`	`lengthOfMonth()` Yields the length of current islamic month in days.
`int`	`lengthOfYear()` Yields the length of current islamic year in days.
`HijriCalendar`	`minus(int amount, HijriCalendar.Unit unit)` Subtracts given calendrical units from this instance.
`HijriCalendar`	`nextDay()` Convenient short form for `with(DAY_OF_MONTH.incremented())`.
`HijriCalendar`	`nextMonth()` Convenient short form for `with(MONTH_OF_YEAR.incremented())`.
`HijriCalendar`	`nextYear()` Convenient short form for `with(YEAR_OF_ERA.incremented())`.
`static HijriCalendar`	`nowInSystemTime(java.lang.String variant, StartOfDay startOfDay)` Obtains the current calendar date in system time.
`static HijriCalendar`	`nowInSystemTime(VariantSource variantSource, StartOfDay startOfDay)` Obtains the current calendar date in system time.
`static HijriCalendar`	`of(java.lang.String variant, int hyear, HijriMonth hmonth, int hdom)` Creates a new instance of a Hijri calendar date in given variant.
`static HijriCalendar`	`of(java.lang.String variant, int hyear, int hmonth, int hdom)` Creates a new instance of a Hijri calendar date in given variant.
`static HijriCalendar`	`of(VariantSource variantSource, int hyear, HijriMonth hmonth, int hdom)` Creates a new instance of a Hijri calendar date in given variant.
`static HijriCalendar`	`of(VariantSource variantSource, int hyear, int hmonth, int hdom)` Creates a new instance of a Hijri calendar date in given variant.
`static HijriCalendar`	`ofUmalqura(int hyear, HijriMonth hmonth, int hdom)` Creates a new instance of a Hijri calendar date in the variant "islamic-umalqura" used in Saudi-Arabia.
`static HijriCalendar`	`ofUmalqura(int hyear, int hmonth, int hdom)` Creates a new instance of a Hijri calendar date in the variant "islamic-umalqura" used in Saudi-Arabia.
`HijriCalendar`	`plus(int amount, HijriCalendar.Unit unit)` Adds given calendrical units to this instance.
`java.lang.String`	`toString()` Provides a complete textual representation of the state of this calendar variant.

Methods inherited from class net.time4j.engine.CalendarVariant
compareTo, getDaysSinceEpochUTC, isAfter, isBefore, isSimultaneous, minus, plus, transform, transform, transform, withVariant, withVariant

Methods inherited from class net.time4j.engine.ChronoEntity
contains, get, get, getInt, getMaximum, getMinimum, getRegisteredElements, getTimezone, hasTimezone, isValid, isValid, isValid, matches, with, with, with, with

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

- Field Detail
  - ERA
```
@FormattableElement(format="G")
public static final ChronoElement<HijriEra> ERA
```
    Represents the islamic era.
  - YEAR_OF_ERA
```
@FormattableElement(format="y")
public static final StdCalendarElement<java.lang.Integer,HijriCalendar> YEAR_OF_ERA
```
    Represents the islamic year.
  - MONTH_OF_YEAR
```
@FormattableElement(format="M",
                    standalone="L")
public static final StdCalendarElement<HijriMonth,HijriCalendar> MONTH_OF_YEAR
```
    Represents the islamic month.
  - DAY_OF_MONTH
```
@FormattableElement(format="d")
public static final StdCalendarElement<java.lang.Integer,HijriCalendar> DAY_OF_MONTH
```
    Represents the islamic day of month.
  - DAY_OF_YEAR
```
@FormattableElement(format="D")
public static final StdCalendarElement<java.lang.Integer,HijriCalendar> DAY_OF_YEAR
```
    Represents the islamic day of year.
  - DAY_OF_WEEK
```
@FormattableElement(format="E")
public static final StdCalendarElement<Weekday,HijriCalendar> DAY_OF_WEEK
```
    Represents the islamic day of week.
    
    If the day-of-week is set to a new value then Time4J handles the islamic calendar week as starting on Sunday.
  - VARIANT_UMALQURA
```
public static final java.lang.String VARIANT_UMALQURA
```
    The name of Umm-al-qura-variant.
    The supported range of islamic years is 1300-1500.
    
    See Also:
    
    Constant Field Values
  - VARIANT_ICU4J
```
public static final java.lang.String VARIANT_ICU4J
```
    The name of the astronomical ICU4J-variant.
    The supported range of islamic years is 1-1600.
    
    Since:
    
    3.6/4.4
    
    See Also:
    
    Constant Field Values
  - VARIANT_DIYANET
```
public static final java.lang.String VARIANT_DIYANET
```
    The name of the Turkish Diyanet-variant.
    The supported range is 1318-01-01/1444-05-29 (ISO: 1900-05-01/2022-12-23).
    
    Since:
    
    3.9/4.6
    
    See Also:
    
    Constant Field Values
- Method Detail
  - of
```
public static HijriCalendar of(java.lang.String variant,
                               int hyear,
                               HijriMonth hmonth,
                               int hdom)
```
    Creates a new instance of a Hijri calendar date in given variant.
    
    Parameters:
    
    variant - calendar variant
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.5/4.3
  - of
```
public static HijriCalendar of(java.lang.String variant,
                               int hyear,
                               int hmonth,
                               int hdom)
```
    Creates a new instance of a Hijri calendar date in given variant.
    
    Parameters:
    
    variant - calendar variant
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.5/4.3
  - of
```
public static HijriCalendar of(VariantSource variantSource,
                               int hyear,
                               HijriMonth hmonth,
                               int hdom)
```
    Creates a new instance of a Hijri calendar date in given variant.
    
    Parameters:
    
    variantSource - source of calendar variant
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.6/4.4
  - of
```
public static HijriCalendar of(VariantSource variantSource,
                               int hyear,
                               int hmonth,
                               int hdom)
```
    Creates a new instance of a Hijri calendar date in given variant.
    
    Parameters:
    
    variantSource - source of calendar variant
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.6/4.4
  - ofUmalqura
```
public static HijriCalendar ofUmalqura(int hyear,
                                       HijriMonth hmonth,
                                       int hdom)
```
    Creates a new instance of a Hijri calendar date in the variant "islamic-umalqura" used in Saudi-Arabia.
    
    Parameters:
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.5/4.3
  - ofUmalqura
```
public static HijriCalendar ofUmalqura(int hyear,
                                       int hmonth,
                                       int hdom)
```
    Creates a new instance of a Hijri calendar date in the variant "islamic-umalqura" used in Saudi-Arabia.
    
    Parameters:
    
    hyear - islamic year
    
    hmonth - islamic month
    
    hdom - islamic day of month
    
    Returns:
    
    new instance of HijriCalendar
    
    Throws:
    
    ChronoException - if given variant is not supported
    
    java.lang.IllegalArgumentException - in case of any inconsistencies
    
    Since:
    
    3.5/4.3
  - nowInSystemTime
```
public static HijriCalendar nowInSystemTime(java.lang.String variant,
                                            StartOfDay startOfDay)
```
    Obtains the current calendar date in system time.
    
    Convenient short-cut for: SystemClock.inLocalView().now(HijriCalendar.family(), variant, startOfDay).toDate()).
    
    Parameters:
    
    variant - calendar variant
    
    startOfDay - determines the exact time of day when the calendar date will change (usually in the evening)
    
    Returns:
    
    current calendar date in system time zone using the system clock
    
    Since:
    
    3.23/4.19
    
    See Also:
    
    SystemClock.inLocalView(), ZonalClock.now(CalendarFamily, String, StartOfDay), StartOfDay.EVENING
  - nowInSystemTime
```
public static HijriCalendar nowInSystemTime(VariantSource variantSource,
                                            StartOfDay startOfDay)
```
    Obtains the current calendar date in system time.
    
    Convenient short-cut for: SystemClock.inLocalView().now(HijriCalendar.family(), variantSource, startOfDay).toDate()).
    
    Parameters:
    
    variantSource - source of calendar variant
    
    startOfDay - determines the exact time of day when the calendar date will change (usually in the evening)
    
    Returns:
    
    current calendar date in system time zone using the system clock
    
    Since:
    
    3.23/4.19
    
    See Also:
    
    SystemClock.inLocalView(), ZonalClock.now(CalendarFamily, VariantSource, StartOfDay), StartOfDay.EVENING
  - getEra
```
public HijriEra getEra()
```
    Yields the islamic era.
    
    Returns:
    
    HijriEra.ANNO_HEGIRAE
    
    Since:
    
    3.5/4.3
  - getYear
```
public int getYear()
```
    Yields the islamic year.
    
    Returns:
    
    int
    
    Since:
    
    3.5/4.3
  - getMonth
```
public HijriMonth getMonth()
```
    Yields the islamic month.
    
    Returns:
    
    enum
    
    Since:
    
    3.5/4.3
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Yields the islamic day of month.
    
    Returns:
    
    int
    
    Since:
    
    3.5/4.3
  - getDayOfWeek
```
public Weekday getDayOfWeek()
```
    Determines the day of week.
    
    The Hijri calendar also uses a 7-day-week.
    
    Returns:
    
    Weekday
    
    Since:
    
    3.5/4.3
  - getDayOfYear
```
public int getDayOfYear()
```
    Yields the islamic day of year.
    
    Returns:
    
    int
    
    Since:
    
    3.5/4.3
  - getVariant
```
public java.lang.String getVariant()
```
    Description copied from class: CalendarVariant
    
    Returns the name of the associated variant of underlying calendar system.
    
    Specified by:
    
    getVariant in class CalendarVariant<HijriCalendar>
    
    Returns:
    
    String
    
    See Also:
    
    CalendarFamily.getCalendarSystem(String)
  - lengthOfMonth
```
public int lengthOfMonth()
```
    Yields the length of current islamic month in days.
    
    Returns:
    
    int
    
    Since:
    
    3.6/4.4
  - lengthOfYear
```
public int lengthOfYear()
```
    Yields the length of current islamic year in days.
    
    Returns:
    
    int
    
    Throws:
    
    ChronoException - if data are not available for the whole year (edge case)
    
    Since:
    
    3.6/4.4
  - nextYear
```
public HijriCalendar nextYear()
```
    Convenient short form for with(YEAR_OF_ERA.incremented()).
    
    Returns:
    
    copy of this instance at next year
    
    Since:
    
    3.5/4.3
  - nextMonth
```
public HijriCalendar nextMonth()
```
    Convenient short form for with(MONTH_OF_YEAR.incremented()).
    
    Returns:
    
    copy of this instance at next month
    
    Since:
    
    3.5/4.3
  - nextDay
```
public HijriCalendar nextDay()
```
    Convenient short form for with(DAY_OF_MONTH.incremented()).
    
    Returns:
    
    copy of this instance at next day
    
    Since:
    
    3.5/4.3
  - at
```
public GeneralTimestamp<HijriCalendar> at(PlainTime time)
```
    Creates a new local timestamp with this date and given wall time.
    
    If the time T24:00 is used then the resulting timestamp will automatically be normalized such that the timestamp will contain the following day instead.
    
    Parameters:
    
    time - wall time
    
    Returns:
    
    general timestamp as composition of this date and given time
    
    Since:
    
    3.8/4.5
  - atTime
```
public GeneralTimestamp<HijriCalendar> atTime(int hour,
                                              int minute)
```
    Is equivalent to at(PlainTime.of(hour, minute)).
    
    Parameters:
    
    hour - hour of day in range (0-24)
    
    minute - minute of hour in range (0-59)
    
    Returns:
    
    general timestamp as composition of this date and given time
    
    Throws:
    
    java.lang.IllegalArgumentException - if any argument is out of range
    
    Since:
    
    3.8/4.5
  - plus
```
public HijriCalendar plus(int amount,
                          HijriCalendar.Unit unit)
```
    Adds given calendrical units to this instance.
    
    Parameters:
    
    amount - amount to be added (maybe negative)
    
    unit - calendrical unit
    
    Returns:
    
    result of addition as changed copy, this instance remains unaffected
    
    Throws:
    
    java.lang.ArithmeticException - in case of numerical overflow
    
    Since:
    
    3.14/4.10
  - minus
```
public HijriCalendar minus(int amount,
                           HijriCalendar.Unit unit)
```
    Subtracts given calendrical units from this instance.
    
    Parameters:
    
    amount - amount to be subtracted (maybe negative)
    
    unit - calendrical unit
    
    Returns:
    
    result of subtraction as changed copy, this instance remains unaffected
    
    Throws:
    
    java.lang.ArithmeticException - in case of numerical overflow
    
    Since:
    
    3.14/4.10
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from class: CalendarVariant
    
    Compares the whole state of this instance with given object.
    
    Implementations will usually define their state based on the temporal position and the variant name. Exceptions from this rule should be explicitly documented and reasoned.
    
    Specified by:
    
    equals in class CalendarVariant<HijriCalendar>
    
    See Also:
    
    CalendarVariant.compareTo(CalendarVariant)
  - hashCode
```
public int hashCode()
```
    Description copied from class: CalendarVariant
    
    Subclasses must redefine this method corresponding to the behaviour of equals().
    
    Specified by:
    
    hashCode in class CalendarVariant<HijriCalendar>
  - toString
```
public java.lang.String toString()
```
    Description copied from class: CalendarVariant
    
    Provides a complete textual representation of the state of this calendar variant.
    
    Specified by:
    
    toString in class CalendarVariant<HijriCalendar>
  - getDefaultWeekmodel
```
public static Weekmodel getDefaultWeekmodel()
```
    Obtains the standard week model of this calendar.
    
    The Hijri calendar usually starts on Sunday, but with the weekend on Friday and Saturday (like in Saudi-Arabia).
    
    Returns:
    
    Weekmodel
    
    Since:
    
    3.24/4.20
  - family
```
public static CalendarFamily<HijriCalendar> family()
```
    Returns the associated calendar family.
    
    Returns:
    
    chronology as calendar family
    
    Since:
    
    3.5/4.3
  - getVersion
```
public static java.lang.String getVersion(java.lang.String variant)
```
    Determines the data version of given variant.
    
    This method serves for data analysis only.
    
    Parameters:
    
    variant - name of islamic calendar variant
    
    Returns:
    
    version info (maybe empty if not relevant)
    
    Throws:
    
    ChronoException - if the variant is not recognized
    
    Since:
    
    3.9/4.6

Class HijriCalendar

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class net.time4j.engine.CalendarVariant

Methods inherited from class net.time4j.engine.ChronoEntity

Methods inherited from class java.lang.Object

Field Detail

ERA

YEAR_OF_ERA

MONTH_OF_YEAR

DAY_OF_MONTH

DAY_OF_YEAR

DAY_OF_WEEK

VARIANT_UMALQURA

VARIANT_ICU4J

VARIANT_DIYANET

Method Detail

of

of

of

of

ofUmalqura

ofUmalqura

nowInSystemTime

nowInSystemTime

getEra

getYear

getMonth

getDayOfMonth

getDayOfWeek

getDayOfYear

getVariant

lengthOfMonth

lengthOfYear

nextYear

nextMonth

nextDay

at

atTime

plus

minus

equals

hashCode

toString

getDefaultWeekmodel

family

getVersion