com.whaleal.icefrog.extra.pinyin.engine.PinyinFactory 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.engine;

import com.whaleal.icefrog.core.lang.Singleton;
import com.whaleal.icefrog.core.util.ServiceLoaderUtil;
import com.whaleal.icefrog.core.util.StrUtil;
import com.whaleal.icefrog.extra.pinyin.PinyinEngine;
import com.whaleal.icefrog.extra.pinyin.PinyinException;
import com.whaleal.icefrog.log.StaticLog;

/**
 * 简单拼音引擎工厂，用于根据用户引入的拼音库jar，自动创建对应的拼音引擎对象
 *
 * @author looly
 */
public class PinyinFactory {

    /**
     * 获得单例的PinyinEngine
     *
     * @return 单例的PinyinEngine
     */
    public static PinyinEngine get() {
        return Singleton.get(PinyinEngine.class.getName(), PinyinFactory::create);
    }

    /**
     * 根据用户引入的拼音引擎jar，自动创建对应的拼音引擎对象

     * 推荐创建的引擎单例使用，此方法每次调用会返回新的引擎
     *
     * @return {@link PinyinEngine}
     */
    public static PinyinEngine create() {
        final PinyinEngine engine = doCreate();
        StaticLog.debug("Use [{}] Engine As Default.", StrUtil.removeSuffix(engine.getClass().getSimpleName(), "Engine"));
        return engine;
    }

    /**
     * 根据用户引入的拼音引擎jar，自动创建对应的拼音引擎对象

     * 推荐创建的引擎单例使用，此方法每次调用会返回新的引擎
     *
     * @return {@link PinyinEngine}
     */
    private static PinyinEngine doCreate() {
        final PinyinEngine engine = ServiceLoaderUtil.loadFirstAvailable(PinyinEngine.class);
        if (null != engine) {
            return engine;
        }

        throw new PinyinException("No pinyin jar found ! Please add one of it to your project !");
    }
}