V2NIMCollectionOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.V2NIMCollection;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMQueryDirection;
import java.io.Serializable;

public class V2NIMCollectionOption implements Serializable {

    // 查询开始时间区间，闭区间
    private final long beginTime;

    // 查询结束时间区间，闭区间
    // endTime大于beginTime
    private final long endTime;

    // 查询锚点
    // 如果anchor为空， 则以beginTime，endTime为准
    // 如果anchor不为空
    //     如果direction为DESC，
    //         endTime不为0， 则必须等于anchor的时间， 否则报错
    //         endTime为0， 则以anchor为准
    //     如果direction为ASC
    //         beginTime不为0， 则必须等于anchor的时间， 否则报错
    //         beginTime为0， 则以anchor为准
    //     查询内部不包括anchor
    private final V2NIMCollection anchorCollection;

    // 查询方向
    // 默认按时间从大到小查询 V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_OLDER
    private final V2NIMQueryDirection direction;

    // 每次查询收藏条数
    // 不超过200
    private final int limit;

    // 收藏类型
    // 为0表示查询所有类型
    private final int collectionType;

    private V2NIMCollectionOption() {
        this(0, 0, null, DEFAULT_DIRECTION, DEFAULT_LIMIT, 0);
    }

    private V2NIMCollectionOption(long beginTime, long endTime, V2NIMCollection anchorCollection, V2NIMQueryDirection direction, int limit, int collectionType) {
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.anchorCollection = anchorCollection;
        this.direction = direction == null ? DEFAULT_DIRECTION : direction;
        this.limit = limit;
        this.collectionType = collectionType;
    }

    public long getBeginTime() {
        return beginTime;
    }

    public long getEndTime() {
        return endTime;
    }

    public V2NIMCollection getAnchorCollection() {
        return anchorCollection;
    }

    public V2NIMQueryDirection getDirection() {
        if (direction == null) {
            return DEFAULT_DIRECTION;
        } else {
            return direction;
        }
    }

    public int getLimit() {
        return limit;
    }

    public int getCollectionType() {
        return collectionType;
    }

    @Override
    public String toString() {
        return "V2NIMCollectionOption{" +
                "beginTime=" + beginTime +
                ", endTime=" + endTime +
                ", anchorCollection=" + anchorCollection +
                ", direction=" + direction +
                ", limit=" + limit +
                ", collectionType=" + collectionType +
                '}';
    }

    private final static V2NIMQueryDirection DEFAULT_DIRECTION = V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC;
    private final static int DEFAULT_LIMIT = 100;

    public static final class V2NIMCollectionOptionBuilder {
        private long beginTime;
        private long endTime;
        private V2NIMQueryDirection direction = DEFAULT_DIRECTION;
        private V2NIMCollection anchorCollection;
        private int limit = DEFAULT_LIMIT;
        private int collectionType;

        private V2NIMCollectionOptionBuilder() {
        }

        public static V2NIMCollectionOptionBuilder builder() {
            return new V2NIMCollectionOptionBuilder();
        }

        public V2NIMCollectionOptionBuilder withBeginTime(long beginTime) {
            this.beginTime = beginTime;
            return this;
        }

        public V2NIMCollectionOptionBuilder withEndTime(long endTime) {
            this.endTime = endTime;
            return this;
        }

        public V2NIMCollectionOptionBuilder withDirection(V2NIMQueryDirection direction) {
            this.direction = direction;
            return this;
        }

        public V2NIMCollectionOptionBuilder withAnchorCollection(V2NIMCollection anchorCollection) {
            this.anchorCollection = anchorCollection;
            return this;
        }

        public V2NIMCollectionOptionBuilder withLimit(int limit) {
            this.limit = limit;
            return this;
        }

        public V2NIMCollectionOptionBuilder withCollectionType(int collectionType) {
            this.collectionType = collectionType;
            return this;
        }

        public V2NIMCollectionOption build() {
            return new V2NIMCollectionOption(beginTime, endTime, anchorCollection, direction, limit, collectionType);
        }
    }
}