Added in API level 26

HijrahEra

class HijrahEra : Era
kotlin.Any
   ↳ kotlin.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

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

Public methods
String!
getDisplayName(style: TextStyle!, locale: Locale!)

Gets the textual representation of this era.

Int

Gets the numeric era int value.

static HijrahEra!
of(hijrahEra: Int)

Obtains an instance of HijrahEra from an int value.

ValueRange!

Gets the range of valid values for the specified field.

Inherited functions

Enum values

AH

Added in API level 26
enum val AH : HijrahEra

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

Public methods

getDisplayName

Added in API level 26
fun getDisplayName(
    style: TextStyle!,
    locale: Locale!
): String!

Gets the textual representation of this era.

This returns the textual name used to identify the era, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters
style TextStyle!: the style of the text required, not null
locale Locale!: the locale to use, not null
Return
String! the text value of the era, not null

getValue

Added in API level 26
fun getValue(): Int

Gets the numeric era int value.

The era AH has the value 1.

Return
Int the era value, 1 (AH)

of

Added in API level 26
static fun of(hijrahEra: 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
Return
HijrahEra! the HijrahEra.AH singleton, not null
Exceptions
java.time.DateTimeException if the value is invalid

range

Added in API level 26
fun range(field: TemporalField!): ValueRange!

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
Return
ValueRange! the range of valid values for the field, not null
Exceptions
java.time.DateTimeException if the range for the field cannot be obtained
java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported