fr.ouestfrance.querydsl.postgrest.model.Pageable Maven / Gradle / Ivy

Go to download
package fr.ouestfrance.querydsl.postgrest.model;

/**
 * Interface to describe pageable criteria
 */
public interface Pageable {

    /**
     * Create a simple pageRequest with size and no declarative sort
     *
     * @param pageSize number of element in one page
     * @return pageable object
     */
    static Pageable ofSize(int pageSize) {
        return ofSize(pageSize, null);
    }

    /**
     * Create a simple pageRequest with size and declarative sort
     *
     * @param pageSize number of element in one page
     * @param sort     sort information
     * @return pageable object
     */
    static Pageable ofSize(int pageSize, Sort sort) {
        return ofSize(0, pageSize, sort);
    }


    /**
     * Create a simple pageRequest with page number and size and declarative sort
     *
     * @param pageNumber number of the request
     * @param pageSize   number of element in one page
     * @param sort       sort information
     * @return pageable object
     */
    static Pageable ofSize(int pageNumber, int pageSize, Sort sort) {
        return new PageRequest(pageNumber, pageSize, sort);
    }

    /**
     * Create an un paged
     *
     * @return pageable object
     */
    static Pageable unPaged() {
        return new PageRequest(0, 0, null);
    }

    /**
     * Request page size
     *
     * @return page size
     */
    int getPageSize();

    /**
     * Request page number
     *
     * @return page number
     */
    int getPageNumber();

    /**
     * Request sort
     *
     * @return sort
     */
    Sort getSort();

    /**
     * Transform a Pageable to range representation
     *
     * @return transform a pagination item to range value
     */
    default String toRange() {
        return pageOffset() + "-" + pageLimit();
    }


    /**
     * Calculate the page offset (index of the first item)
     *
     * @return page offset
     */
    default int pageOffset() {
        return getPageNumber() * getPageSize();
    }

    /**
     * Calculate the page limit (index of the last item)
     *
     * @return page limit
     */
    default int pageLimit() {
        return pageOffset() + getPageSize() - 1;
    }

    /**
     * Return the next page
     *
     * @return next page
     */
    default Pageable next() {
        return new PageRequest(getPageNumber() + 1, getPageSize(), getSort());
    }

    /**
     * Return the previous page or the first one
     *
     * @return previous page
     */
    default Pageable previous() {
        return getPageNumber() == 0 ? this : new PageRequest(getPageNumber() - 1, getPageSize(), getSort());
    }

    /**
     * Indicates that the pageable object is unPaged
     *
     * @return true if unPaged
     */
    default boolean hasSize() {
        return getPageSize() > 0;
    }
}