V2NIMCreateTopicParams.java

浏览该文件的文档.

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

/**
 * 创建 Topic 参数。
 */
public class V2NIMCreateTopicParams {
    private static final int MAX_TOPIC_NAME_LENGTH = 128;

    /**
     * Topic 类型；未设置时默认值为 0。
     */
    private final Integer type;
    /**
     * Topic 名称。
     */
    private final String topicName;
    /**
     * 服务端扩展字段。
     */
    private final String serverExtension;

    /**
     * 构造创建 Topic 参数。
     *
     * @param type Topic 类型；如果设置，则必须大于 0
     * @param topicName Topic 名称，最大长度为 128 个字符
     * @param serverExtension 服务端扩展字段
     */
    public V2NIMCreateTopicParams(int type, String topicName, String serverExtension) {
        this.type = type;
        this.topicName = topicName;
        this.serverExtension = serverExtension;
    }

    /**
     * 构造创建 Topic 参数。
     *
     * @param topicName Topic 名称，最大长度为 128 个字符
     * @param serverExtension 服务端扩展字段
     */
    public V2NIMCreateTopicParams(String topicName, String serverExtension) {
        this.type = null;
        this.topicName = topicName;
        this.serverExtension = serverExtension;
    }

    /**
     * 返回 Topic 类型。
     *
     * @return Topic 类型；未指定时为 0
     */
    public int getType() {
        return type == null ? 0 : type;
    }

    /**
     * Topic 类型是否已显式设置。
     *
     * @return `true` 表示已显式设置 Topic 类型，否则为 `false`
     */
    public boolean hasType() {
        return type != null;
    }

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

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

    /**
     * 返回参数非法原因。
     *
     * @return 参数合法时返回 `null`，否则返回具体错误原因
     */
    public String isValidWithErrorMsg() {
        if (type != null && type <= 0) {
            return "type must be greater than 0";
        }
        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;
    }
}