Top Description Fields Constructors Methods
java.time.chrono

public final Enum HijrahEra

extends Enum<HijrahEra>
implements Era
Class Inheritance
All Implemented Interfaces
java.time.chrono.Era, java.time.temporal.TemporalAdjuster, java.time.temporal.TemporalAccessor
Static Imports
java.time.temporal.ChronoField.ERA
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.

Implementation Specification

This is an immutable and thread-safe enum.

Since
1.8

Field Summary

Modifier and TypeField and Description
public static final HijrahEra
AH

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

Constructor Summary

AccessConstructor and Description
private
HijrahEra()

Method Summary

Modifier and TypeMethod and Description
public String
getDisplayName(TextStyle
the style of the text required, not null
style, Locale
the locale to use, not null
locale)

Overrides default java.time.chrono.Era.getDisplayName.

Gets the textual representation of this era.

public int

Returns:

the era value, 1 (AH)
getValue()

Implements java.time.chrono.Era.getValue.

Gets the numeric era int value.

public static HijrahEra

Returns:

the HijrahEra.AH singleton, not null
of(int
the era to represent, only 1 supported
hijrahEra)

Obtains an instance of HijrahEra from an int value.

public ValueRange

Returns:

the range of valid values for the field, not null
range(TemporalField
the field to query the range for, not null
field)

Overrides default java.time.chrono.Era.range.

Gets the range of valid values for the specified field.

public static HijrahEra
valueOf(String name)

public static HijrahEra[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AHback to summary
public static final HijrahEra AH

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

Constructor Detail

HijrahEraback to summary
private HijrahEra()

Method Detail

getDisplayNameback to summary
public String getDisplayName(TextStyle style, Locale locale)

Overrides default java.time.chrono.Era.getDisplayName.

Doc from java.time.chrono.Era.getDisplayName.

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

Returns:String

the text value of the era, not null

Annotations
@Override
getValueback to summary
public int getValue()

Implements java.time.chrono.Era.getValue.

Gets the numeric era int value.

The era AH has the value 1.

Returns:int

the era value, 1 (AH)

Annotations
@Override
ofback to summary
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

Exceptions
DateTimeException:
if the value is invalid
rangeback to summary
public ValueRange range(TemporalField field)

Overrides default java.time.chrono.Era.range.

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

Annotations
@Override
Exceptions
DateTimeException:
if the range for the field cannot be obtained
UnsupportedTemporalTypeException:
if the unit is not supported
valueOfback to summary
public static HijrahEra valueOf(String name)
valuesback to summary
public static HijrahEra[] values()