- All Implemented Interfaces:
Serializable
,Comparable<HijrahEra>
,Constable
,Era
,TemporalAccessor
,TemporalAdjuster
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 Requirements:
- This is an immutable and thread-safe enum.
- Since:
- 1.8
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe singleton instance for the current era, 'Anno Hegirae', which has the numeric value 1. -
Method Summary
Modifier and TypeMethodDescriptiongetDisplayName
(TextStyle style, Locale locale) Gets the textual representation of this era.int
getValue()
Gets the numeric eraint
value.static HijrahEra
of
(int hijrahEra) Obtains an instance ofHijrahEra
from anint
value.range
(TemporalField field) Gets the range of valid values for the specified field.static HijrahEra
Returns the enum constant of this class with the specified name.static HijrahEra[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods declared in class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods declared in interface java.time.chrono.Era
adjustInto, get, getLong, isSupported, query
-
Enum Constant Details
-
AH
The singleton instance for the current era, 'Anno Hegirae', which has the numeric value 1.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
of
Obtains an instance ofHijrahEra
from anint
value.The current era, which is the only accepted value, has the value 1
- Parameters:
hijrahEra
- the era to represent, only 1 supported- Returns:
- the HijrahEra.AH singleton, not null
- Throws:
DateTimeException
- if the value is invalid
-
getValue
-
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. TheERA
field returns the range. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)
passingthis
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.- Specified by:
range
in interfaceEra
- Specified by:
range
in interfaceTemporalAccessor
- Parameters:
field
- the field to query the range for, not null- Returns:
- the range of valid values for the field, not null
- Throws:
DateTimeException
- if the range for the field cannot be obtainedUnsupportedTemporalTypeException
- if the unit is not supported
-
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.- Specified by:
getDisplayName
in interfaceEra
- Parameters:
style
- the style of the text required, not nulllocale
- the locale to use, not null- Returns:
- the text value of the era, not null
-