Package org.miaixz.bus.extra.pinyin

Interface PinyinProvider

All Superinterfaces:

org.miaixz.bus.core.Provider

All Known Implementing Classes:

Bopomofo4JProvider, HoubbProvider, JPinyinProvider, Pinyin4JProvider, TinyPinyinProvider

public interface PinyinProvider
extends org.miaixz.bus.core.Provider

拼音引擎接口，具体的拼音实现通过实现此接口，完成具体实现功能

Since:

Java 17+

Author:

Kimi Liu

Method Summary

Modifier and Type	Method	Description
default char	getFirstLetter(char c)	将输入字符串转为拼音首字母，其它字符原样返回
default String	getFirstLetter(String text, String separator)	将输入字符串转为拼音首字母，其它字符原样返回
String	getPinyin(char c)	如果c为汉字，则返回大写拼音；如果c不是汉字，则返回String.valueOf(c)
String	getPinyin(String text, String separator)	获取字符串对应的完整拼音，非中文返回原字符
default Object	type()

Method Details

getPinyin

String getPinyin(char c)

如果c为汉字，则返回大写拼音；如果c不是汉字，则返回String.valueOf(c)

Parameters:

c - 任意字符，汉字返回拼音，非汉字原样返回

Returns:

汉字返回拼音，非汉字原样返回

getPinyin

String getPinyin(String text,
 String separator)

获取字符串对应的完整拼音，非中文返回原字符

Parameters:

text - 字符串

separator - 拼音之间的分隔符

Returns:

拼音

getFirstLetter

default char getFirstLetter(char c)

将输入字符串转为拼音首字母，其它字符原样返回

Parameters:

c - 任意字符，汉字返回拼音，非汉字原样返回

Returns:

汉字返回拼音，非汉字原样返回

getFirstLetter

default String getFirstLetter(String text,
 String separator)

将输入字符串转为拼音首字母，其它字符原样返回

Parameters:

text - 任意字符，汉字返回拼音，非汉字原样返回

separator - 分隔符

Returns:

汉字返回拼音，非汉字原样返回

type

default Object type()

Specified by:

type in interface org.miaixz.bus.core.Provider