V2NIMClearLocalMessageParams.java

浏览该文件的文档.

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

import java.util.Objects;

/**
 * V2NIM 清空本地消息参数类
 * 用于配置清空本地消息的相关参数，包括时间范围和是否删除会话入口
 */
public class V2NIMClearLocalMessageParams {

    
    /**
     * 清理指定时间之前的所有消息
     * 默认值为0 ， 表示当前时间，表示清理当前时间之前的所有消息
     * 单位：毫秒
     */
    private long anchorTime = 0;
    
    /**
     * 是否同步删除会话入口，主要删除本地会话
     * true：表示会同步删除时间段内相关的会话入口
     * false：会话入口会保留
     * 默认值：false
     */
    private boolean deleteConversation = false;
    
    /**
     * 默认构造函数
     */
    public V2NIMClearLocalMessageParams() {
    }
    
    /**
     * 带参数的构造函数
     *
     * @param anchorTime 清空的时间范围的结束时间（毫秒）
     * @param deleteConversation 是否删除会话入口
     */
    public V2NIMClearLocalMessageParams(long anchorTime, boolean deleteConversation) {
        this.anchorTime = anchorTime;
        this.deleteConversation = deleteConversation;
    }

    /**
     * 获取清空的时间范围的结束时间
     * @return 结束时间（毫秒）
     */
    public long getAnchorTime() {
        return anchorTime;
    }

    /**
     * 设置清空的时间范围的结束时间
     * @param anchorTime 结束时间（毫秒）
     */
    public void setAnchorTime(long anchorTime) {
        this.anchorTime = anchorTime;
        if(this.anchorTime < 0){
            this.anchorTime = 0;
        }
    }
    
    /**
     * 获取是否同步删除会话入口的标志
     * 
     * @return true表示会同步删除时间段内相关的会话入口，false表示会话入口会保留
     */
    public boolean isDeleteConversation() {
        return deleteConversation;
    }
    
    /**
     * 设置是否同步删除会话入口
     * 
     * @param deleteConversation true表示会同步删除时间段内相关的会话入口，false表示会话入口会保留
     */
    public void setDeleteConversation(boolean deleteConversation) {
        this.deleteConversation = deleteConversation;
    }
    
    /**
     * 参数校验方法
     * 
     * @return true表示参数有效，false表示参数无效
     */
    public boolean isValid() {
        return anchorTime >= 0;
    }
    
    /**
     * 重写toString方法，便于调试和日志输出
     * 
     * @return 对象的字符串表示
     */
    @Override
    public String toString() {
        return "V2NIMClearLocalMessageParams{" +
                "anchorTime=" + anchorTime +
                ", deleteConversation=" + deleteConversation +
                '}';
    }
    
    /**
     * 重写equals方法
     * 
     * @param obj 比较对象
     * @return 是否相等
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        
        V2NIMClearLocalMessageParams that = (V2NIMClearLocalMessageParams) obj;
        
        return anchorTime == that.anchorTime &&
               deleteConversation == that.deleteConversation;
    }
    
    /**
     * 重写hashCode方法
     * 
     * @return 哈希码
     */
    @Override
    public int hashCode() {
        return Objects.hash(anchorTime, deleteConversation);
    }
}