com.taotao.boot.pinyin.api.IPinyinContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taotao-boot-starter-pinyin Show documentation

taotao-boot-starter-pinyin

The newest version!

/*
 * Copyright (c) 2020-2030, Shuigedeng ([email protected] & https://blog.taotaocloud.top/).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.taotao.boot.pinyin.api;

import com.taotao.boot.pinyin.spi.IPinyinChinese;
import com.taotao.boot.pinyin.spi.IPinyinData;
import com.taotao.boot.pinyin.spi.IPinyinSegment;
import com.taotao.boot.pinyin.spi.IPinyinTone;
import com.taotao.boot.pinyin.spi.IPinyinToneReverse;
import com.taotao.boot.pinyin.spi.IPinyinToneStyle;

/** 拼音核心用户 api 上下文 */
public interface IPinyinContext {

    /**
     * 样式
     *
     * @return 样式
     */
    IPinyinToneStyle style();

    /**
     * 分词实现
     *
     * @return 分词
     */
    IPinyinSegment segment();

    /**
     * 拼音数据实现
     *
     * @return 数据实现
     */
    IPinyinData data();

    /**
     * 中文服务类
     *
     * @return 中文服务类
     */
    IPinyinChinese chinese();

    /**
     * 注音实现
     *
     * @return 注音实现
     */
    IPinyinTone tone();

    /**
     * 连接符
     *
     * @return 连接符
     */
    String connector();

    /**
     * 拼音反向
     *
     * @return 实现
     */
    IPinyinToneReverse pinyinToneReverse();
}