net.time4j.calendar

Enum SexagesimalName.Branch

java.lang.Object

java.lang.Enum<SexagesimalName.Branch>

net.time4j.calendar.SexagesimalName.Branch

All Implemented Interfaces:

Serializable, Comparable<SexagesimalName.Branch>

Enclosing class:

SexagesimalName

public static enum SexagesimalName.Branch
extends Enum<SexagesimalName.Branch>

Defines the twelvth terrestrial branches with their animal signs (zodiacs).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHEN_5_DRAGON
CHOU_2_OX
HAI_12_PIG
MAO_4_HARE
SHEN_9_MONKEY
SI_6_SNAKE
WEI_8_SHEEP
WU_7_HORSE
XU_11_DOG
YIN_3_TIGER
YOU_10_FOWL
ZI_1_RAT

Method Summary

Modifier and Type	Method and Description
String	getDisplayName(Locale locale) Obtains the localized name of this terrestrial branch.
String	getZodiac(Locale locale) Obtains the animal describing this terrestrial branch.
static SexagesimalName.Branch	valueOf(String name) Returns the enum constant of this type with the specified name.
static SexagesimalName.Branch[]	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

Enum Constant Detail

ZI_1_RAT

public static final SexagesimalName.Branch ZI_1_RAT

CHOU_2_OX

public static final SexagesimalName.Branch CHOU_2_OX

YIN_3_TIGER

public static final SexagesimalName.Branch YIN_3_TIGER

MAO_4_HARE

public static final SexagesimalName.Branch MAO_4_HARE

CHEN_5_DRAGON

public static final SexagesimalName.Branch CHEN_5_DRAGON

SI_6_SNAKE

public static final SexagesimalName.Branch SI_6_SNAKE

WU_7_HORSE

public static final SexagesimalName.Branch WU_7_HORSE

WEI_8_SHEEP

public static final SexagesimalName.Branch WEI_8_SHEEP

SHEN_9_MONKEY

public static final SexagesimalName.Branch SHEN_9_MONKEY

YOU_10_FOWL

public static final SexagesimalName.Branch YOU_10_FOWL

XU_11_DOG

public static final SexagesimalName.Branch XU_11_DOG

HAI_12_PIG

public static final SexagesimalName.Branch HAI_12_PIG

Method Detail

values

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

Returns:

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

valueOf

public static SexagesimalName.Branch 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)

Obtains the localized name of this terrestrial branch.

Parameters:

locale - language

Returns:

display name

See Also:

SexagesimalName.getDisplayName(Locale)

getZodiac

public String getZodiac(Locale locale)

Obtains the animal describing this terrestrial branch.

Parameters:

locale - language

Returns:

name of associated zodiac animal