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

String getDisplayName(TextStyle style, Locale locale)

Gets the textual representation of this era.

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

final Object clone()

Throws CloneNotSupportedException.

final int compareTo(HijrahEra o)

Compares this enum with the specified object for order.

final boolean equals(Object other)

Returns true if the specified object is equal to this enum constant.

final void finalize()

enum classes cannot have finalize methods.

final Class<HijrahEra> getDeclaringClass()

Returns the Class object corresponding to this enum constant's enum type.

final int hashCode()

Returns a hash code for this enum constant.

final String name()

Returns the name of this enum constant, exactly as declared in its enum declaration.

final int ordinal()

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

String toString()

Returns the name of this enum constant, as contained in the declaration.

static <T extends Enum<T>> T valueOf(Class<T> enumClass, String name)

Returns the enum constant of the specified enum class with the specified name.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int compareTo(HijrahEra o)

Compares this object with the specified object for order.

default Temporal adjustInto(Temporal temporal)

Adjusts the specified temporal object to have the same era as this object.

default int get(TemporalField field)

Gets the value of the specified field from this era as an int.

default String getDisplayName(TextStyle style, Locale locale)

Gets the textual representation of this era.

default long getLong(TemporalField field)

Gets the value of the specified field from this era as a long.

abstract int getValue()

Gets the numeric value associated with the era as defined by the chronology.

default boolean isSupported(TemporalField field)

Checks if the specified field is supported.

default <R> R query(TemporalQuery<R> query)

Queries this era using the specified query.

default ValueRange range(TemporalField field)

Gets the range of valid values for the specified field.

default int get(TemporalField field)

Gets the value of the specified field as an int.

abstract long getLong(TemporalField field)

Gets the value of the specified field as a long.

abstract boolean isSupported(TemporalField field)

Checks if the specified field is supported.

default <R> R query(TemporalQuery<R> query)

Queries this date-time.

default ValueRange range(TemporalField field)

Gets the range of valid values for the specified field.

abstract Temporal adjustInto(Temporal temporal)

Adjusts the specified temporal object.

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

getDisplayName

Added in API level 26
public String getDisplayName (TextStyle style, 
                Locale locale)

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:

locale Locale:

Returns
String the text value of the era, not null

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

public static HijrahEra valueOf (String name)

Parameters
name String

Returns
HijrahEra

values

public static final HijrahEra[] values ()

Returns
HijrahEra[]