NIMMessageRouteConfig.java

浏览该文件的文档.

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

import java.io.Serializable;

/**
 * NIMMessageRouteConfig类
 * <p>
 * 该类用于配置消息路由。它实现了Serializable接口，可以被序列化。
 */
public class NIMMessageRouteConfig implements Serializable {

  /**
   * 是否需要路由消息。（抄送）
   */
    private final boolean routeEnabled;
    /**
     * 环境变量，用于指向不同的抄送，第三方回调等配置
     */
    private final String routeEnvironment;

    /**
     * 私有构造函数
     * 使用默认的路由启用设置和null环境变量创建实例
     */
    private NIMMessageRouteConfig() {
        this(DEFAULT_ROUTE_ENABLE, null);
    }

    /**
     * 私有构造函数
     *
     * @param routeEnabled     是否启用路由
     * @param routeEnvironment 路由环境变量
     */
    private NIMMessageRouteConfig(boolean routeEnabled, String routeEnvironment) {
        this.routeEnabled = routeEnabled;
        this.routeEnvironment = routeEnvironment;
    }

    /**
     * 获取路由是否启用
     *
     * @return 路由是否启用
     */
    public boolean isRouteEnabled() {
        return routeEnabled;
    }

    /**
     * 获取路由环境变量
     *
     * @return 路由环境变量
     */
    public String getRouteEnvironment() {
        return routeEnvironment;
    }

    /**
     * 重写toString方法
     *
     * @return 包含对象信息的字符串
     */
    @Override
    public String toString() {
        return "NIMMessageRouteConfig{" + "routeEnabled=" + routeEnabled + ", routeEnvironment='" + routeEnvironment + '\'' + '}';
    }

    /**
     * 默认路由启用设置
     */
    public static final boolean DEFAULT_ROUTE_ENABLE = true;

    /**
     * NIMMessageRouteConfigBuilder内部类
     * 用于构建NIMMessageRouteConfig实例
     */
    public static final class NIMMessageRouteConfigBuilder {

        private boolean routeEnabled = DEFAULT_ROUTE_ENABLE;
        private String  routeEnvironment;

        private NIMMessageRouteConfigBuilder() {
        }

        /**
         * 创建NIMMessageRouteConfigBuilder实例
         *
         * @return NIMMessageRouteConfigBuilder实例
         */
        public static NIMMessageRouteConfigBuilder builder() {
            return new NIMMessageRouteConfigBuilder();
        }

        /**
         * 设置是否启用路由
         *
         * @param routeEnabled 是否启用路由
         *
         * @return 当前NIMMessageRouteConfigBuilder实例
         */
        public NIMMessageRouteConfigBuilder withRouteEnabled(boolean routeEnabled) {
            this.routeEnabled = routeEnabled;
            return this;
        }

        /**
         * 设置路由环境变量
         *
         * @param routeEnvironment 路由环境变量
         *
         * @return 当前NIMMessageRouteConfigBuilder实例
         */
        public NIMMessageRouteConfigBuilder withRouteEnvironment(String routeEnvironment) {
            this.routeEnvironment = routeEnvironment;
            return this;
        }

        /**
         * 构建NIMMessageRouteConfig实例
         *
         * @return 新的NIMMessageRouteConfig实例
         */
        public NIMMessageRouteConfig build() {
            return new NIMMessageRouteConfig(routeEnabled, routeEnvironment);
        }
    }
}