io.github.honhimw.ms.model.PageRequest Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.honhimw.ms.model;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.EqualsAndHashCode;

import java.io.Serializable;
import java.util.Objects;

/**
 * @author hon_him
 * @since 2024-01-05
 */

@Data
@EqualsAndHashCode(callSuper = false)
@AllArgsConstructor
public class PageRequest implements Serializable {

    /**
     * Default offset
     */
    public static final int DEFAULT_OFFSET = 0;
    /**
     * Default limit
     */
    public static final int DEFAULT_LIMIT = 20;

    /**
     * page no, grater than or equal to 0
     */
    @Schema(description = "page no, >= 0")
    private Integer no;

    /**
     * page size, grater than 0
     */
    @Schema(description = "page size, > 0")
    private Integer size;

    /**
     * page no, grater than or equal to 0
     */
    @Schema(description = "page no, >= 0")
    private Integer limit;

    /**
     * page size, grater than 0
     */
    @Schema(description = "page size, > 0")
    private Integer offset;

    /**
     * Constructs a new {@code PageRequest} with the default {@code no} and {@code size}.
     */
    public PageRequest() {
        this.no = 0;
        this.size = 20;
    }

    /**
     * Constructs a new {@code PageRequest} with the given {@code no} and {@code size}.
     *
     * @param no   page no
     * @param size page size
     * @return a new {@code PageRequest}
     */
    public static PageRequest of(int no, int size) {
        PageRequest pageRequest = new PageRequest();
        pageRequest.setNo(no);
        pageRequest.setSize(size);
        return pageRequest;
    }

    /**
     * set no
     * @param no page no
     * @return this
     */
    public PageRequest no(int no) {
        setNo(no);
        return this;
    }

    /**
     * set size
     * @param size page size
     * @return this
     */
    public PageRequest size(int size) {
        setSize(size);
        return this;
    }

    /**
     * set offset
     * @param offset offset
     * @return this
     */
    public PageRequest offset(int offset) {
        setOffset(offset);
        return this;
    }

    /**
     * set limit
     * @param limit limit
     * @return this
     */
    public PageRequest limit(int limit) {
        setLimit(limit);
        return this;
    }

    /**
     * Get offset based on {@code no} and {@code size}
     * @return offset
     */
    public int toOffset() {
        if (Objects.nonNull(this.offset)) {
            return offset;
        }
        return no * size;
    }

    /**
     * Get limit based on {@code size}
     * @return limit
     */
    public int toLimit() {
        if (Objects.nonNull(this.limit)) {
            return limit;
        }
        return size;
    }

    /**
     * set default
     */
    public void useDefault() {
        this.offset = DEFAULT_OFFSET;
        this.limit = DEFAULT_LIMIT;
    }

}