net.time4j.calendar

Enum IndianEra

java.lang.Object

java.lang.Enum<IndianEra>

net.time4j.calendar.IndianEra

All Implemented Interfaces:

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

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

The Indian national calendar only supports one single era called "Saka".

Since:

3.32/4.27

Enum Constant Summary

Enum Constants

Enum Constant and Description
SAKA Singleton instance (starting in 78 AD as year zero).

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

SAKA

public static final IndianEra SAKA

Singleton instance (starting in 78 AD as year zero).

Method Detail

values

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

Returns:

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

valueOf

public static IndianEra 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)

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)