Package net.time4j.calendar

Enum Class HijriEra

java.lang.Object

java.lang.Enum<HijriEra>

net.time4j.calendar.HijriEra

All Implemented Interfaces:

Serializable, Comparable<HijriEra>, java.lang.constant.Constable, CalendarEra

public enum HijriEra
extends Enum<HijriEra>
implements CalendarEra

The Hijri calendar only supports one single era called "Anno Hegirae" with the numerical value 1.

Since:

3.5/4.3

Author:

Meno Hochschild

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANNO_HEGIRAE	Singleton instance (often abbreviated as "AH").

Method Summary

Modifier and Type	Method	Description
String	getDisplayName(Locale locale)	Equivalent to the expression getDisplayName(locale, TextWidth.WIDE).
String	getDisplayName(Locale locale, TextWidth width)	Gets the description text dependent on the locale and style parameters.
static HijriEra	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HijriEra[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.engine.CalendarEra

name

Enum Constant Details

ANNO_HEGIRAE

public static final HijriEra ANNO_HEGIRAE

Singleton instance (often abbreviated as "AH").

Method Details

values

public static HijriEra[] 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

public static HijriEra valueOf(String name)

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 name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName(Locale locale)

Equivalent to the expression getDisplayName(locale, TextWidth.WIDE).

Parameters:

locale - language setting

Returns:

descriptive text (long form, never null)

Since:

3.5/4.3

See Also:

getDisplayName(Locale, TextWidth)

getDisplayName

public String getDisplayName(Locale locale,
 TextWidth width)

Gets the description text dependent on the locale and style parameters.

The second argument controls the width of description.

Parameters:

locale - language setting

width - text width

Returns:

descriptive text for given locale and style (never null)

Since:

3.5/4.3