org.nlpcn.commons.lang.pinyin

Enum YuCharType

java.lang.Object

java.lang.Enum<YuCharType>

org.nlpcn.commons.lang.pinyin.YuCharType

All Implemented Interfaces:

Serializable, Comparable<YuCharType>

public enum YuCharType
extends Enum<YuCharType>

Define the output format of character 'ü'

'ü' is a special character of Hanyu Pinyin, which can not be simply represented by English letters. In Hanyu Pinyin, such characters include 'ü', 'üe', 'üan', and 'ün'.

This class provides several options for output of 'ü', which are listed below.

Options	Output
WITH_U_AND_COLON	u:
WITH_V	v
WITH_U_UNICODE	ü

Author:

luhuiguo

Enum Constant Summary

Enum Constants

Enum Constant and Description
WITH_U_AND_COLON The option indicates that the output of 'ü' is "u:".
WITH_U_UNICODE The option indicates that the output of 'ü' is "ü" in Unicode form.
WITH_V The option indicates that the output of 'ü' is "v".

Method Summary

Modifier and Type	Method and Description
static YuCharType	valueOf(String name) Returns the enum constant of this type with the specified name.
static YuCharType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WITH_U_AND_COLON

public static final YuCharType WITH_U_AND_COLON

The option indicates that the output of 'ü' is "u:".

WITH_V

public static final YuCharType WITH_V

The option indicates that the output of 'ü' is "v".

WITH_U_UNICODE

public static final YuCharType WITH_U_UNICODE

The option indicates that the output of 'ü' is "ü" in Unicode form.

Method Detail

values

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

Returns:

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

valueOf

public static YuCharType 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