V2NIMTextTranslateParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.params;

import java.io.Serializable;

/**
 * 文本翻译参数类
 * <p>
 * 用于配置文本翻译请求的相关参数
 * </p>
 */
public class V2NIMTextTranslateParams implements Serializable {

    /**
     * 源语言默认值，表示自动识别
     */
    public static final String DEFAULT_SOURCE_LANGUAGE = "";

    /**
     * 需要翻译的文本信息
     * <p>
     * 最大长度 5000 字符，如果内容为 null 或者为 ""（空串），返回参数错误
     * </p>
     * <p>
     * 内部逻辑：客户端不校验文本长度，由服务器控制
     * </p>
     */
    private String text;

    /**
     * 输入文本对应的语言
     * <p>
     * 如果不传则默认为自动识别，如果明确源语言类型则输入源语言类型标识
     * </p>
     * <p>
     * 支持输入："auto"，表示自动识别
     * </p>
     * <p>
     * 内部逻辑：如果传入为 null 或者空串，则 SDK 内部转换为 "auto" 字符串提交给服务器
     * </p>
     */
    private String sourceLanguage;

    /**
     * 文本翻译的目标语言
     * <p>
     * 如果内容为 null 或者为 ""（空串），返回参数错误
     * </p>
     * <p>
     * 示例："en"，更多支持的语言代码请参考官方文档中的支持语言列表
     * </p>
     */
    private String targetLanguage;

    /**
     * 默认构造函数
     */
    public V2NIMTextTranslateParams() {
        this(null, DEFAULT_SOURCE_LANGUAGE, null);
    }

    /**
     * 带参数的构造函数
     *
     * @param text           需要翻译的文本信息
     * @param sourceLanguage 输入文本对应的语言
     * @param targetLanguage 文本翻译的目标语言
     */
    public V2NIMTextTranslateParams(String text, String sourceLanguage, String targetLanguage) {
        this.text = text;
        this.sourceLanguage = sourceLanguage;
        this.targetLanguage = targetLanguage;
    }

    /**
     * 获取需要翻译的文本信息
     * <p>
     * 最大长度 5000 字符
     * </p>
     *
     * @return 需要翻译的文本信息
     */
    public String getText() {
        return text;
    }

    /**
     * 设置需要翻译的文本信息
     * <p>
     * 最大长度 5000 字符，如果内容为 null 或者为 ""（空串），返回参数错误
     * </p>
     * <p>
     * 注意：客户端不校验文本长度，由服务器控制
     * </p>
     *
     * @param text 需要翻译的文本信息
     */
    public void setText(String text) {
        this.text = text;
    }

    /**
     * 获取输入文本对应的语言
     * <p>
     * 如果为空或 null，SDK 内部会转换为 "auto" 提交给服务器
     * </p>
     *
     * @return 输入文本对应的语言标识
     */
    public String getSourceLanguage() {
        return sourceLanguage;
    }

    /**
     * 设置输入文本对应的语言
     * <p>
     * 如果不传则默认为自动识别，如果明确源语言类型则输入源语言类型标识
     * </p>
     * <p>
     * 支持输入："auto"，表示自动识别
     * </p>
     * <p>
     * 内部逻辑：如果传入为 null 或者空串，则 SDK 内部转换为 "auto" 字符串提交给服务器
     * </p>
     *
     * @param sourceLanguage 输入文本对应的语言标识
     */
    public void setSourceLanguage(String sourceLanguage) {
        this.sourceLanguage = sourceLanguage;
    }

    /**
     * 获取文本翻译的目标语言
     *
     * @return 文本翻译的目标语言标识
     */
    public String getTargetLanguage() {
        return targetLanguage;
    }

    /**
     * 设置文本翻译的目标语言
     * <p>
     * 如果内容为 null 或者为 ""（空串），返回参数错误
     * </p>
     * <p>
     * 示例："en"，更多支持的语言代码请参考官方文档中的支持语言列表
     * </p>
     *
     * @param targetLanguage 文本翻译的目标语言标识
     */
    public void setTargetLanguage(String targetLanguage) {
        this.targetLanguage = targetLanguage;
    }

    @Override
    public String toString() {
        return "V2NIMTextTranslateParams{" +
                "text='" + text + '\'' +
                ", sourceLanguage='" + sourceLanguage + '\'' +
                ", targetLanguage='" + targetLanguage + '\'' +
                '}';
    }

    /**
     * 参数校验方法
     * <p>
     * 校验必填参数是否有效：
     * <ul>
     *     <li>text：不能为 null 或空串</li>
     *     <li>targetLanguage：不能为 null 或空串</li>
     * </ul>
     * </p>
     *
     * @return true 表示参数有效，false 表示参数无效
     */
    public boolean isValid() {
        // 校验 text：不能为 null 或空串
        if (text == null || text.isEmpty()) {
            return false;
        }
        // 校验 targetLanguage：不能为 null 或空串
        if (targetLanguage == null || targetLanguage.isEmpty()) {
            return false;
        }
        return true;
    }

    /**
     * V2NIMTextTranslateParams 构建器
     * <p>
     * 用于通过链式调用构建 V2NIMTextTranslateParams 实例
     * </p>
     */
    public static final class V2NIMTextTranslateParamsBuilder {

        /**
         * 需要翻译的文本信息（必填）
         */
        private final String text;

        /**
         * 输入文本对应的语言
         */
        private String sourceLanguage = DEFAULT_SOURCE_LANGUAGE;

        /**
         * 文本翻译的目标语言（必填）
         */
        private final String targetLanguage;

        /**
         * 私有构造函数
         *
         * @param text           需要翻译的文本信息（必填）
         * @param targetLanguage 文本翻译的目标语言（必填）
         */
        private V2NIMTextTranslateParamsBuilder(String text, String targetLanguage) {
            this.text = text;
            this.targetLanguage = targetLanguage;
        }

        /**
         * 创建 V2NIMTextTranslateParamsBuilder 实例
         * <p>
         * 必填参数通过此方法传入
         * </p>
         *
         * @param text           需要翻译的文本信息，最大长度 5000 字符，不能为 null 或空串
         * @param targetLanguage 文本翻译的目标语言，不能为 null 或空串，示例："en"
         * @return V2NIMTextTranslateParamsBuilder 实例
         */
        public static V2NIMTextTranslateParamsBuilder builder(String text, String targetLanguage) {
            return new V2NIMTextTranslateParamsBuilder(text, targetLanguage);
        }

        /**
         * 设置输入文本对应的语言
         * <p>
         * 如果不设置则默认为自动识别（SDK 内部转换为 "auto"）
         * </p>
         * <p>
         * 支持输入："auto"，表示自动识别
         * </p>
         *
         * @param sourceLanguage 输入文本对应的语言标识
         * @return V2NIMTextTranslateParamsBuilder 实例
         */
        public V2NIMTextTranslateParamsBuilder withSourceLanguage(String sourceLanguage) {
            this.sourceLanguage = sourceLanguage;
            return this;
        }

        /**
         * 构建 V2NIMTextTranslateParams 实例
         *
         * @return V2NIMTextTranslateParams 实例
         */
        public V2NIMTextTranslateParams build() {
            return new V2NIMTextTranslateParams(text, sourceLanguage, targetLanguage);
        }
    }
}