V2NIMUpdateTopicParams.java

浏览该文件的文档.

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

import android.text.TextUtils;
import com.netease.nimlib.sdk.v2.topic.V2NIMTopic;

/**
 * 更新 Topic 参数。
 */
public class V2NIMUpdateTopicParams {
    private static final int MAX_TOPIC_NAME_LENGTH = 128;

    /**
     * 待更新的 Topic。
     */
    private final V2NIMTopic topic;
    /**
     * 新的 Topic 名称。
     */
    private final String topicName;
    /**
     * 新的服务端扩展字段。
     */
    private final String serverExtension;

    /**
     * 构造更新 Topic 参数。
     *
     * @param topic 待更新的 Topic
     * @param topicName 新的 Topic 名称，最大长度为 128 个字符
     * @param serverExtension 新的服务端扩展字段
     */
    public V2NIMUpdateTopicParams(V2NIMTopic topic, String topicName, String serverExtension) {
        this.topic = topic;
        this.topicName = topicName;
        this.serverExtension = serverExtension;
    }

    /**
     * 返回待更新的 Topic。
     *
     * @return 待更新的 Topic
     */
    public V2NIMTopic getTopic() {
        return topic;
    }

    /**
     * 返回新的 Topic 名称。
     *
     * @return 新的 Topic 名称，最大长度为 128 个字符
     */
    public String getTopicName() {
        return topicName;
    }

    /**
     * 返回新的服务端扩展字段。
     *
     * @return 新的服务端扩展字段
     */
    public String getServerExtension() {
        return serverExtension;
    }

    /**
     * 返回参数非法原因。
     *
     * @return 参数合法时返回 `null`，否则返回具体错误原因
     */
    public String isValidWithErrorMsg() {
        if (topic == null) {
            return "topic is null";
        }
        if (TextUtils.isEmpty(topic.getConversationId())) {
            return "topic conversationId is empty";
        }
        if (topic.getTopicId() <= 0) {
            return "topicId must be greater than 0";
        }
        if (topic.getCreateTime() <= 0) {
            return "topic createTime must be greater than 0";
        }
        if (topicName == null && serverExtension == null) {
            return "topicName and serverExtension cannot both be null";
        }
        if (topicName != null && topicName.length() > MAX_TOPIC_NAME_LENGTH) {
            return "topicName length must be less than or equal to 128";
        }
        return null;
    }

    /**
     * 参数是否合法。
     *
     * @return `true` 表示参数合法，否则为 `false`
     */
    public boolean isValid() {
        return isValidWithErrorMsg() == null;
    }
}