net.time4j.calendar

Enum PersianEra

java.lang.Object

java.lang.Enum<PersianEra>

net.time4j.calendar.PersianEra

All Implemented Interfaces:

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

public enum PersianEra
extends java.lang.Enum<PersianEra>
implements CalendarEra

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

Since:

3.9/4.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNO_PERSICO Singleton instance (often abbreviated as "AP").

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 PersianEra	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersianEra[]	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_PERSICO

public static final PersianEra ANNO_PERSICO

Singleton instance (often abbreviated as "AP").

Method Detail

values

public static PersianEra[] 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 (PersianEra c : PersianEra.values())
    System.out.println(c);

Returns:

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

valueOf

public static PersianEra 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.

Attention: This number is neither necessarily unique nor does it imply any chronological order.

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.9/4.6

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.9/4.6