net.guerlab.web.result.ListObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guerlab-web Show documentation
net.guerlab.web is a suite of spring web expanded libraries that include utility classes and much much more.
The newest version!
/*
 * Copyright 2018-2021 guerlab.net and other contributors.
 *
 * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.guerlab.web.result;

import java.util.Collection;
import java.util.Collections;

/**
 * 列表对象
 *
 * @author guer
 *
 * @param 
 *            数据类型
 */
public class ListObject {

    @SuppressWarnings("rawtypes")
    public static final ListObject EMPTY = new EmptyListObject<>();

    /**
     * 数据列表
     */
    private Collection list = Collections.emptyList();

    /**
     * 数据总数
     */
    private long count = 0L;

    /**
     * 查询内容数量
     */
    private long pageSize = 10L;

    /**
     * 当前页面ID
     */
    private long currentPageId = 1L;

    /**
     * 最大页面ID
     */
    private long maxPageId = 1L;

    /**
     * 无参构造
     */
    public ListObject() {
        /*
         * not to do something
         */
    }

    /**
     * 通过分页尺寸构造对象
     *
     * @param pageSize
     *            分页尺寸
     */
    public ListObject(int pageSize) {
        this.pageSize = pageSize;
    }

    /**
     * 通过分页尺寸、数据总数构造对象
     *
     * @param pageSize
     *            分页尺寸
     * @param count
     *            数据总数
     */
    public ListObject(long pageSize, long count) {
        this.pageSize = pageSize;
        this.count = count;
    }

    /**
     * 通过分页尺寸、数据总数、数据列表构造对象
     *
     * @param pageSize
     *            分页尺寸
     * @param count
     *            数据总数
     * @param dataList
     *            数据列表
     */
    public ListObject(long pageSize, long count, Collection dataList) {
        this(pageSize, count);

        if (dataList != null) {
            list = dataList;
        }
    }

    /**
     * 通过分页尺寸、数据总数、数据读取命令构造对象
     *
     * @param pageSize
     *            分页尺寸
     * @param count
     *            数据总数
     * @param command
     *            数据读取命令
     */
    public ListObject(long pageSize, long count, ReadDataListCommand command) {
        this(pageSize, count);

        if (count <= 0 || command == null) {
            return;
        }

        Collection dataList = command.getData();
        if (dataList != null) {
            list = dataList;
        }
    }

    /**
     * 获取空列表对象
     *
     * @param 
     *         参数对象类型
     * @return 空列表对象
     */
    @SuppressWarnings("unchecked")
    public static  ListObject empty() {
        return EMPTY;
    }

    /**
     * 返回数据列表
     *
     * @return 数据列表
     */
    public Collection getList() {
        return list;
    }

    /**
     * 设置数据列表
     *
     * @param list
     *            数据列表
     */
    public void setList(Collection list) {
        this.list = list;
    }

    /**
     * 返回数据总数
     *
     * @return 数据总数
     */
    public long getCount() {
        return count;
    }

    /**
     * 设置数据总数
     *
     * @param count
     *            数据总数
     */
    public void setCount(long count) {
        this.count = count;
    }

    /**
     * 返回分页尺寸
     *
     * @return 分页尺寸
     */
    public long getPageSize() {
        return pageSize;
    }

    /**
     * 设置分页尺寸
     *
     * @param pageSize
     *            分页尺寸
     */
    public void setPageSize(long pageSize) {
        this.pageSize = pageSize;
    }

    /**
     * 返回当前页面ID
     *
     * @return 当前页面ID
     */
    public long getCurrentPageId() {
        return currentPageId;
    }

    /**
     * 设置当前页面ID
     *
     * @param currentPageId
     *            当前页面ID
     */
    public void setCurrentPageId(long currentPageId) {
        this.currentPageId = currentPageId;
    }

    /**
     * 返回最大页面ID
     *
     * @return 最大页面ID
     */
    public long getMaxPageId() {
        return maxPageId;
    }

    /**
     * 设置最大页面ID
     *
     * @param maxPageId
     *            最大页面ID
     */
    public void setMaxPageId(long maxPageId) {
        this.maxPageId = maxPageId;
    }

    private static class EmptyListObject extends ListObject {

        @Override
        public void setList(Collection list) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void setCount(long count) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void setPageSize(long pageSize) {
            throw new UnsupportedOperationException();
        }
    }
}