Package com.blazebit.persistence.deltaspike.data.rest

Annotation Type PageableDefault

@Retention(RUNTIME) @Target(PARAMETER) public @interface PageableDefault
Annotation, heavily inspired by Spring Data's PageableDefault, for configuring the Pageable default values to use when no query parameters are given. It's illegal to supply both, a SortDefault or SortDefault.SortDefaults configuration and sort() and direction().
Since:
1.2.0
Author:
Christian Beikov

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Sort.Direction
    direction
    The sort direction to use for sort of a Pageable when no sort direction is defined for a path.
    boolean
    oneIndexed
    Whether the page is 1-based rather than 0-based.
    int
    page
    The page to use for a Pageable when no page query parameter is defined.
    String
    pageName
    The query parameter name for the page parameter.
    String
    pageSizeName
    The query parameter name for the page size parameter.
    int
    size
    The page size to use for a Pageable when no page size query parameter is defined.
    String[]
    sort
    The paths to use for sort of a Pageable when no sort query parameter is defined.
    String
    sortName
    The query parameter name for the sort parameter.

  • Element Details

    • size

      int size
      The page size to use for a Pageable when no page size query parameter is defined.
      Returns:
      The default page size
      Default:
      10

    • page

      int page
      The page to use for a Pageable when no page query parameter is defined.
      Returns:
      The default page
      Default:
      0

    • sort

      String[] sort
      The paths to use for sort of a Pageable when no sort query parameter is defined.
      Returns:
      The default paths to sort by
      Default:
      {}

    • direction

      Sort.Direction direction
      The sort direction to use for sort of a Pageable when no sort direction is defined for a path. Defaults to Sort.Direction.ASC.
      Returns:
      The default direction to sort by
      Default:
      ASC

    • pageName

      String pageName
      The query parameter name for the page parameter.
      Returns:
      The page query parameter name
      Default:
      ""

    • pageSizeName

      String pageSizeName
      The query parameter name for the page size parameter.
      Returns:
      The page size query parameter name
      Default:
      ""

    • sortName

      String sortName
      The query parameter name for the sort parameter.
      Returns:
      The sort query parameter name
      Default:
      ""

    • oneIndexed

      boolean oneIndexed
      Whether the page is 1-based rather than 0-based.
      Returns:
      true if 1-base, false if 0-based
      Default:
      false