PinyinToneNumEnum (pinyin 0.3.1 API)

java.lang.Object
- java.lang.Enum<PinyinToneNumEnum>
- - com.github.houbb.pinyin.constant.enums.PinyinToneNumEnum

所有已实现的接口:

Serializable, Comparable<PinyinToneNumEnum>
```
public enum PinyinToneNumEnum
extends Enum<PinyinToneNumEnum>
```
拼音音调编号枚举
project: pinyin-PinyinToneNumEnum

create on 2020/2/23 17:01

从以下版本开始:

0.1.0

作者:

binbin.hou

枚举常量概要

枚举常量
枚举常量和说明
`FIVE`
`FOUR`
`ONE` 声调枚举在现代汉语四声中，第一声、第二声是平声；第三声、第四声是仄声。
`THREE`
`TWO`
`UN_KNOWN`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`String`	`desc()`
`static boolean`	`isPing(int toneNum)` 是否为平声字
`static boolean`	`isSoftly(int toneNum)` 是否为轻声
`static boolean`	`isZe(int toneNum)` 是否为仄声字
`int`	`num()`
`String`	`toString()`
`static PinyinToneNumEnum`	`valueOf(String name)` 返回带有指定名称的该类型的枚举常量。
`static PinyinToneNumEnum[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - ONE
```
public static final PinyinToneNumEnum ONE
```
    声调枚举在现代汉语四声中，第一声、第二声是平声；第三声、第四声是仄声。古代的入声字已经被均摊到这几种读音之中。
    
    从以下版本开始:
    
    0.1.0
  - TWO
```
public static final PinyinToneNumEnum TWO
```
  - THREE
```
public static final PinyinToneNumEnum THREE
```
  - FOUR
```
public static final PinyinToneNumEnum FOUR
```
  - FIVE
```
public static final PinyinToneNumEnum FIVE
```
  - UN_KNOWN
```
public static final PinyinToneNumEnum UN_KNOWN
```
- 方法详细资料
  - values
```
public static PinyinToneNumEnum[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (PinyinToneNumEnum c : PinyinToneNumEnum.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static PinyinToneNumEnum valueOf(String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    NullPointerException - 如果参数为空值
  - num
```
public int num()
```
  - desc
```
public String desc()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Enum<PinyinToneNumEnum>
  - isPing
```
public static boolean isPing(int toneNum)
```
    是否为平声字
    
    参数:
    
    toneNum - 音调
    
    返回:
    
    结果
    
    从以下版本开始:
    
    0.1.0
  - isZe
```
public static boolean isZe(int toneNum)
```
    是否为仄声字
    
    参数:
    
    toneNum - 音调
    
    返回:
    
    结果
    
    从以下版本开始:
    
    0.1.0
  - isSoftly
```
public static boolean isSoftly(int toneNum)
```
    是否为轻声
    
    参数:
    
    toneNum - 音调
    
    返回:
    
    结果
    
    从以下版本开始:
    
    0.1.0

枚举 PinyinToneNumEnum

枚举常量概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

ONE

TWO

THREE

FOUR

FIVE

UN_KNOWN

方法详细资料

values

valueOf

num

desc

toString

isPing

isZe

isSoftly