cn.hutool.extra.pinyin.engine.pinyin4j

Class Pinyin4jEngine

java.lang.Object

cn.hutool.extra.pinyin.engine.pinyin4j.Pinyin4jEngine

All Implemented Interfaces:

PinyinEngine

public class Pinyin4jEngine
extends Object
implements PinyinEngine

封装了Pinyin4j的引擎。

pinyin4j(http://sourceforge.net/projects/pinyin4j)封装。

引入：

 <dependency>
     <groupId>com.belerweb</groupId>
     <artifactId>pinyin4j</artifactId>
     <version>2.5.1</version>
 </dependency>
 

Author:

looly

Constructor Summary

Constructors

Constructor and Description
Pinyin4jEngine() 构造
Pinyin4jEngine(net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat format) 构造

Method Summary

Modifier and Type	Method and Description
String	getPinyin(char c) 如果c为汉字，则返回大写拼音；如果c不是汉字，则返回String.valueOf(c)
String	getPinyin(char c, boolean tone) 如果c为汉字，则返回大写拼音；如果c不是汉字，则返回String.valueOf(c)
String	getPinyin(String str, String separator) 获取字符串对应的完整拼音，非中文返回原字符
String	getPinyin(String str, String separator, boolean tone) 获取字符串对应的完整拼音，非中文返回原字符
void	init(net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat format) 初始化

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cn.hutool.extra.pinyin.PinyinEngine

getFirstLetter, getFirstLetter

Constructor Detail

Pinyin4jEngine

public Pinyin4jEngine()

构造

Pinyin4jEngine

public Pinyin4jEngine(net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat format)

构造

Parameters:

format - 格式

Method Detail

init

public void init(net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat format)

初始化

Parameters:

format - 格式

getPinyin

public String getPinyin(char c)

Description copied from interface: PinyinEngine

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

Specified by:

getPinyin in interface PinyinEngine

Parameters:

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

Returns:

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

getPinyin

public String getPinyin(char c,
                        boolean tone)

Description copied from interface: PinyinEngine

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

Specified by:

getPinyin in interface PinyinEngine

Parameters:

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

tone - 是否返回声调

Returns:

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

getPinyin

public String getPinyin(String str,
                        String separator)

Description copied from interface: PinyinEngine

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

Specified by:

getPinyin in interface PinyinEngine

Parameters:

str - 字符串

separator - 拼音之间的分隔符

Returns:

拼音

getPinyin

public String getPinyin(String str,
                        String separator,
                        boolean tone)

Description copied from interface: PinyinEngine

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

Specified by:

getPinyin in interface PinyinEngine

Parameters:

str - 字符串

separator - 拼音之间的分隔符

tone - 是否返回声调

Returns:

拼音