HijrahEra

public final enum HijrahEra
extends Enum<HijrahEra> implements Era

java.lang.Object
   ↳ java.lang.Enum<java.time.chrono.HijrahEra>
     ↳ java.time.chrono.HijrahEra


An era in the Hijrah calendar system.

The Hijrah calendar system has only one era covering the proleptic years greater than zero.

Do not use ordinal() to obtain the numeric representation of HijrahEra. Use getValue() instead.

Summary

Enum values

HijrahEra  AH

The singleton instance for the current era, 'Anno Hegirae', which has the numeric value 1. 

Public methods

int getValue()

Gets the numeric era int value.

static HijrahEra of(int hijrahEra)

Obtains an instance of HijrahEra from an int value.

ValueRange range(TemporalField field)

Gets the range of valid values for the specified field.

static HijrahEra valueOf(String name)
static final HijrahEra[] values()

Inherited methods

Enum values

AH

added in API level 26
public static final HijrahEra AH

The singleton instance for the current era, 'Anno Hegirae', which has the numeric value 1.

Public methods

getValue

added in API level 26
public int getValue ()

Gets the numeric era int value.

The era AH has the value 1.

Returns
int the era value, 1 (AH)

of

added in API level 26
public static HijrahEra of (int hijrahEra)

Obtains an instance of HijrahEra from an int value.

The current era, which is the only accepted value, has the value 1

Parameters
hijrahEra int: the era to represent, only 1 supported

Returns
HijrahEra the HijrahEra.AH singleton, not null

Throws
DateTimeException if the value is invalid

range

added in API level 26
public ValueRange range (TemporalField field)

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This era is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The ERA field returns the range. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

The ERA field returns a range for the one valid Hijrah era.

Parameters
field TemporalField: the field to query the range for, not null

Returns
ValueRange the range of valid values for the field, not null

Throws
DateTimeException if the range for the field cannot be obtained
UnsupportedTemporalTypeException if the unit is not supported

valueOf

added in API level 26
public static HijrahEra valueOf (String name)

Parameters
name String

Returns
HijrahEra

values

added in API level 26
public static final HijrahEra[] values ()

Returns
HijrahEra[]