com.github.houbb.pinyin.api

接口 IPinyin

所有已知实现类:

Pinyin

public interface IPinyin

拼音核心用户 api

从以下版本开始:

0.0.1

作者:

binbin.hou

方法概要

限定符和类型	方法和说明
boolean	hasSamePinyin(char chineseOne, char chineseTwo, IPinyinContext context) 是否为同音字
List<String>	samePinyinList(String pinyin, boolean sameToneNum, IPinyinContext context) 相同的拼音列表
List<String>	shengMuList(String chinese, IPinyinContext context) 已过时。
List<Integer>	toneNumList(char chinese, IPinyinContext context) 已过时。
List<Integer>	toneNumList(String chinese, IPinyinContext context) 已过时。
String	toPinyin(String string, IPinyinContext context) 获取指定字符串的拼音
List<String>	toPinyinList(char chinese, IPinyinContext context) 返回所有拼音列表 （1）返回当前汉字的所有拼音列表 （2）如果不是汉字，返回其本身
List<String>	yunMuList(String chinese, IPinyinContext context) 已过时。

方法详细资料

toPinyin

String toPinyin(String string,
                IPinyinContext context)

获取指定字符串的拼音

参数:

string - 原始字符串

context - 上下文

返回:

转换后的结果

从以下版本开始:

0.0.1

toPinyinList

List<String> toPinyinList(char chinese,
                          IPinyinContext context)

返回所有拼音列表 （1）返回当前汉字的所有拼音列表 （2）如果不是汉字，返回其本身

参数:

chinese - 中文汉字

context - 上下文

返回:

返回所有拼音列表

从以下版本开始:

0.0.2

hasSamePinyin

boolean hasSamePinyin(char chineseOne,
                      char chineseTwo,
                      IPinyinContext context)

是否为同音字

参数:

chineseOne - 中文一

chineseTwo - 中文二

context - 上下文

返回:

是否相同

从以下版本开始:

0.0.8

toneNumList

@Deprecated
List<Integer> toneNumList(String chinese,
                                       IPinyinContext context)

已过时。

获取拼音的音调编号 12345

参数:

chinese - 中文拼音

context - 上下文

返回:

结果

从以下版本开始:

0.1.0

toneNumList

@Deprecated
List<Integer> toneNumList(char chinese,
                                       IPinyinContext context)

已过时。

获取拼音的音调编号 12345

参数:

chinese - 中文字符

context - 上下文

返回:

结果

从以下版本开始:

0.1.0

shengMuList

@Deprecated
List<String> shengMuList(String chinese,
                                      IPinyinContext context)

已过时。

获取声母字符

参数:

chinese - 中文汉字

context - 上下文

返回:

结果

从以下版本开始:

0.1.1

yunMuList

@Deprecated
List<String> yunMuList(String chinese,
                                    IPinyinContext context)

已过时。

获取韵母字符

参数:

chinese - 中文字符

context - 上下文

返回:

结果

从以下版本开始:

0.1.1

samePinyinList

List<String> samePinyinList(String pinyin,
                            boolean sameToneNum,
                            IPinyinContext context)

相同的拼音列表

参数:

pinyin - 拼音

sameToneNum - 相同的声调

context - 上下文

返回:

结果

从以下版本开始:

0.3.0