org.kiwiproject.spring.data.PagingRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kiwi Show documentation

Kiwi is a utility library. We really like Google's Guava, and also use Apache Commons. But if they don't have something we need, and we think it is useful, this is where we put it.

There is a newer version: 4.5.2

Show newest version

package org.kiwiproject.spring.data;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.data.domain.Sort;

import javax.ws.rs.DefaultValue;
import javax.ws.rs.QueryParam;

/**
 * JAX-RS based implementation of {@link PagingParams}.
 * 
 * Intended to be used in JAX-RS resource classes with HTTP {@link javax.ws.rs.GET} endpoint methods having an
 * argument annotated with {@link javax.ws.rs.BeanParam}.
 * 

 * Example:
 * 
 * {@literal @}GET
 *  public Response page(@BeanParam PagingRequest pagingRequest) {
 *     // ...
 *  }
 * 
 *
 * @implNote Requires Spring Data Commons and the JAX-RS API to be available at runtime.
 */
@Getter
@Setter
@ToString
public class PagingRequest implements PagingParams {

    public static final int DEFAULT_MAX_LIMIT = 100;

    // IMPLEMENTATION NOTE:
    // For the @DefaultValue annotations using the Sort.Direction enum, we must use a constant value, meaning
    // we cannot use the enum and call name(). And unfortunately, you cannot get around it even if you define a
    // private static final String in this or any other class. The compiler error is always:
    // "element value must be a constant expression"

    /**
     * The page number. Default is zero.
     * 
     * Note this does not preclude using either zero or one-based page numbering, but other classes may require
     * one or the other page numbering scheme.
     */
    @QueryParam("page")
    @DefaultValue("0")
    private Integer page;

    /**
     * The page size limit. Default is 100.
     */
    @QueryParam("limit")
    @DefaultValue("" + DEFAULT_MAX_LIMIT)
    private Integer limit;

    /**
     * The primary sort property. Default is null.
     * 

     * This is only relevant if a primarySort has been specified.
     */
    @QueryParam("primarySort")
    private String primarySort;

    /**
     * The primary sort direction. Default is ascending (ASC).
     */
    @QueryParam("primaryDirection")
    @DefaultValue("ASC")
    private Sort.Direction primaryDirection;

    /**
     * The secondary sort property. Default is null.
     */
    @QueryParam("secondarySort")
    private String secondarySort;

    /**
     * The secondary sort direction. Default is ascending (ASC).
     * 
     * This is only relevant if a secondarySort has been specified.
     */
    @QueryParam("secondaryDirection")
    @DefaultValue("ASC")
    private Sort.Direction secondaryDirection;
}