NIMMessageAIStreamStopParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.params;

import android.text.TextUtils;
import com.netease.nimlib.sdk.msg.enums.NIMMessageAIStreamStopOpType;
import java.io.Serializable;

/**
 * NIMMessageAIStreamStopParams类
 * <p>
 * 该类用于配置停止数字人流式输出的参数。
 * </p>
 *
 * @author jintao
 * @version 1.0
 */
public class NIMMessageAIStreamStopParams implements Serializable {
    
    /**
     * 停止流式消息的操作类型
     * 必填参数
     */
    private NIMMessageAIStreamStopOpType operationType;
    
    /**
     * 更新的消息内容
     * 非必填参数
     * 仅当operationType设置为NIM_MESSAGE_AI_STREAM_STOP_OP_UPDATE时有效
     */
    private String updateContent;
    
    /**
     * 默认构造函数
     */
    private NIMMessageAIStreamStopParams() {
    }
    
    /**
     * 带操作类型的构造函数
     *
     * @param operationType 停止流式消息的操作类型
     */
    public NIMMessageAIStreamStopParams(NIMMessageAIStreamStopOpType operationType) {
        this.operationType = operationType;
    }
    
    /**
     * 完整参数的构造函数
     *
     * @param operationType 停止流式消息的操作类型
     * @param updateContent 更新的消息内容
     */
    public NIMMessageAIStreamStopParams(NIMMessageAIStreamStopOpType operationType, String updateContent) {
        this.operationType = operationType;
        this.updateContent = updateContent;
    }
    
    /**
     * 获取停止流式消息的操作类型
     *
     * @return 操作类型
     */
    public NIMMessageAIStreamStopOpType getOperationType() {
        return operationType;
    }
    
    /**
     * 设置停止流式消息的操作类型
     *
     * @param operationType 操作类型
     */
    public void setOperationType(NIMMessageAIStreamStopOpType operationType) {
        this.operationType = operationType;
    }
    
    /**
     * 获取更新的消息内容
     *
     * @return 更新的消息内容
     */
    public String getUpdateContent() {
        return updateContent;
    }
    
    /**
     * 设置更新的消息内容
     * 注意：此内容仅当operationType为NIM_MESSAGE_AI_STREAM_STOP_OP_UPDATE时有效
     *
     * @param updateContent 更新的消息内容
     */
    public void setUpdateContent(String updateContent) {
        this.updateContent = updateContent;
    }
    
    @Override
    public String toString() {
        return "NIMMessageAIStreamStopParams{" +
                "operationType=" + operationType +
                ", updateContent=" + updateContent +
                '}';
    }

    public boolean isValid() {
        if (operationType == null){
            return false;
        }
        if(operationType == NIMMessageAIStreamStopOpType.NIM_MESSAGE_AI_STREAM_STOP_OP_UPDATE && TextUtils.isEmpty(updateContent)){
            return false;
        }
        return true;
    }
    
    /**
     * 构建器类，用于更方便地创建NIMMessageAIStreamStopParams对象
     */
    public static class Builder {
        private final NIMMessageAIStreamStopOpType operationType;
        private String updateContent;
        
        /**
         * 构造函数，必须指定操作类型
         *
         * @param operationType 停止流式消息的操作类型
         */
        public Builder(NIMMessageAIStreamStopOpType operationType) {
            this.operationType = operationType;
        }
        
        /**
         * 设置更新的消息内容
         *
         * @param updateContent 更新的消息内容
         * @return 构建器实例
         */
        public Builder updateContent(String updateContent) {
            this.updateContent = updateContent;
            return this;
        }
        
        /**
         * 构建NIMMessageAIStreamStopParams对象
         *
         * @return 构建好的NIMMessageAIStreamStopParams对象
         */
        public NIMMessageAIStreamStopParams build() {
            return new NIMMessageAIStreamStopParams(operationType, updateContent);
        }
    }
}