com.whaleal.icefrog.extra.pinyin.PinyinEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of icefrog-extra Show documentation

icefrog 扩展工具类（提供其它类库的封装）

There is a newer version: 1.1.71

package com.whaleal.icefrog.extra.pinyin;

import com.whaleal.icefrog.core.collection.CollUtil;
import com.whaleal.icefrog.core.util.StrUtil;

import java.util.List;

/**
 * 拼音引擎接口，具体的拼音实现通过实现此接口，完成具体实现功能
 *
 * @author looly
 */
public interface PinyinEngine {

    /**
     * 如果c为汉字，则返回大写拼音；如果c不是汉字，则返回String.valueOf(c)
     *
     * @param c 任意字符，汉字返回拼音，非汉字原样返回
     * @return 汉字返回拼音，非汉字原样返回
     */
    String getPinyin( char c );

    /**
     * 获取字符串对应的完整拼音，非中文返回原字符
     *
     * @param str       字符串
     * @param separator 拼音之间的分隔符
     * @return 拼音
     */
    String getPinyin( String str, String separator );

    /**
     * 将输入字符串转为拼音首字母，其它字符原样返回
     *
     * @param c 任意字符，汉字返回拼音，非汉字原样返回
     * @return 汉字返回拼音，非汉字原样返回
     */
    default char getFirstLetter( char c ) {
        return getPinyin(c).charAt(0);
    }

    /**
     * 将输入字符串转为拼音首字母，其它字符原样返回
     *
     * @param str       任意字符，汉字返回拼音，非汉字原样返回
     * @param separator 分隔符
     * @return 汉字返回拼音，非汉字原样返回
     */
    default String getFirstLetter( String str, String separator ) {
        final String splitSeparator = StrUtil.isEmpty(separator) ? "#" : separator;
        final List split = StrUtil.split(getPinyin(str, splitSeparator), splitSeparator);
        return CollUtil.join(split, separator, ( s ) -> String.valueOf(s.length() > 0 ? s.charAt(0) : StrUtil.EMPTY));
    }
}