net.time4j.calendar

Enum HijriEra

java.lang.Object

java.lang.Enum<HijriEra>

net.time4j.calendar.HijriEra

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HijriEra>, CalendarEra

public enum HijriEra
extends java.lang.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

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName(java.util.Locale locale) Equivalent to the expression getDisplayName(locale, TextWidth.WIDE).
java.lang.String	getDisplayName(java.util.Locale locale, TextWidth width) Gets the description text dependent on the locale and style parameters.
int	getValue() Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.
static HijriEra	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HijriEra[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, 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 Detail

ANNO_HEGIRAE

public static final HijriEra ANNO_HEGIRAE

Singleton instance (often abbreviated as "AH").

Method Detail

values

public static HijriEra[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HijriEra c : HijriEra.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HijriEra valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Description copied from interface: CalendarEra

Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.

Specified by:

getValue in interface CalendarEra

Returns:

int

getDisplayName

public java.lang.String getDisplayName(java.util.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 java.lang.String getDisplayName(java.util.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