org.nlpcn.commons.lang.pinyin

Enum ToneType

java.lang.Object

java.lang.Enum<ToneType>

org.nlpcn.commons.lang.pinyin.ToneType

All Implemented Interfaces:

Serializable, Comparable<ToneType>

public enum ToneType
extends Enum<ToneType>

Define the output format of Pinyin tones

Chinese has four pitched tones and a "toneless" tone. They are called Píng(平, flat), Shǎng(上, rise), Qù(去, high drop), Rù(入, drop) and Qing(轻, toneless). Usually, we use 1, 2, 3, 4 and 5 to represent them.

This class provides several options for output of Chinese tones, which are listed below. For example, Chinese character '打'

Options	Output
WITH_TONE_NUMBER	da3
WITHOUT_TONE	da
WITH_TONE_MARK	dǎ

Author:

luhuiguo

Enum Constant Summary

Enum Constants

Enum Constant and Description
WITH_ABBR '打' -> d
WITH_TONE_MARK '打' -> dǎ
WITH_TONE_NUMBER '打' -> da3
WITHOUT_TONE '打' -> da

Method Summary

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

public static final ToneType WITH_TONE_NUMBER

'打' -> da3

WITHOUT_TONE

public static final ToneType WITHOUT_TONE

'打' -> da

WITH_TONE_MARK

public static final ToneType WITH_TONE_MARK

'打' -> dǎ

WITH_ABBR

public static final ToneType WITH_ABBR

'打' -> d

Method Detail

values

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

Returns:

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

valueOf

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