Module jakarta.data

Enum Class PageRequest.Mode

java.lang.Object
java.lang.Enum<PageRequest.Mode>
jakarta.data.page.PageRequest.Mode
All Implemented Interfaces:
Serializable, Comparable<PageRequest.Mode>, Constable
Enclosing interface:
PageRequest

public static enum PageRequest.Mode extends Enum<PageRequest.Mode>
The type of pagination: offset-based or cursor-based, which includes a direction.
  • Enum Constant Details

    • CURSOR_NEXT

      public static final PageRequest.Mode CURSOR_NEXT
      Indicates forward cursor-based pagination, which follows the direction of the sort criteria, using a cursor that is formed from the key of the last entity on the current page.
    • CURSOR_PREVIOUS

      public static final PageRequest.Mode CURSOR_PREVIOUS
      Indicates a request for a page with cursor-based pagination in the previous page direction to the sort criteria, using a cursor that is formed from the key of first entity on the current page. The order of results on each page follows the sort criteria and is not reversed.
    • OFFSET

      public static final PageRequest.Mode OFFSET
      Indicates a request for a page using offset pagination. The starting position for pages is computed as an offset from the first result based on the page number and maximum page size. Offset pagination is used when a cursor is not supplied.
  • Method Details

    • values

      public static PageRequest.Mode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PageRequest.Mode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null