NIMMessageStreamStatus.java

浏览该文件的文档.

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

/**
 * NIMMessageStreamStatus枚举类
 * <p>
 * 该枚举表示流式消息状态
 * </p>
 *
 * @author jintao
 * @version 1.0
 */
public enum NIMMessageStreamStatus {

    /**
     * 流式过程中 (本地状态，其他为服务器状态)
     */
    NIM_MESSAGE_STREAM_STATUS_STREAMING(-1),

    /**
     * 非流式状态
     */
    NIM_MESSAGE_STREAM_STATUS_NONE(0),

    /**
     * 占位
     */
    NIM_MESSAGE_STREAM_STATUS_PLACEHOLDER(1),

    /**
     * 停止输出
     */
    NIM_MESSAGE_STREAM_STATUS_STOPPED(2),

    /**
     * 停止并更新
     */
    NIM_MESSAGE_STREAM_STATUS_UPDATED(3),

    /**
     * 输出完成
     */
    NIM_MESSAGE_STREAM_STATUS_GENERATED(4),

    /**
     * 服务器异常终止
     */
    NIM_MESSAGE_STREAM_STATUS_ABORTED(5);

    /**
     * 枚举值对应的整数值
     */
    private final int value;

    /**
     * 构造函数
     *
     * @param value 枚举对应的整数值
     */
    NIMMessageStreamStatus(int value) {
        this.value = value;
    }
    
    /**
     * 获取枚举对应的整数值
     * 
     * @return 整数值
     */
    public int getValue() {
        return value;
    }

    /**
     * 通过整数值获取对应的枚举实例
     *
     * @param value 整数值
     * @return 对应的枚举实例，如果没找到则返回NIM_MESSAGE_STREAM_STATUS_NONE
     */
    public static NIMMessageStreamStatus typeOfValue(int value) {
        for (NIMMessageStreamStatus status : NIMMessageStreamStatus.values()) {
            if (status.value == value) {
                return status;
            }
        }
        return NIM_MESSAGE_STREAM_STATUS_NONE;
    }
}