net.time4j.calendar

Enum KoreanEra

java.lang.Object

java.lang.Enum<KoreanEra>

net.time4j.calendar.KoreanEra

All Implemented Interfaces:

Serializable, Comparable<KoreanEra>, CalendarEra

public enum KoreanEra
extends Enum<KoreanEra>
implements CalendarEra

The Korean calendar supports the danki-system which is now only historic.

Since:

3.40/4.35

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
DANGI Called after the legendary founder Dangun of the first Korean kingdom Gojoseon in year BC 2333.

Method Summary

Modifier and Type	Method and 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 KoreanEra	valueOf(String name) Returns the enum constant of this type with the specified name.
static KoreanEra[]	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

DANGI

public static final KoreanEra DANGI

Called after the legendary founder Dangun of the first Korean kingdom Gojoseon in year BC 2333.

It was used in South Korea from 1952 until 1961, in North Korea still before 1997.

Method Detail

values

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

Returns:

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

valueOf

public static KoreanEra valueOf(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:

IllegalArgumentException - if this enum type 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)

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)