Package io.micronaut.data.model

Interface Pageable.Cursor

Enclosing interface:
Pageable
public static interface Pageable.Cursor
An interface for defining pagination cursors. It is generally a list of elements which can be used to create a query for the next or previous page.
Since:
4.8.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Object>
    elements()
    Returns all the currentCursor values in a list.
    Object
    get(int index)
    Returns the currentCursor element at the specified position.
    static Pageable.Cursor
    of(Object... elements)
    Create a currentCursor from elements.
    static Pageable.Cursor
    of(List<Object> elements)
    Create a currentCursor from elements.
    int
    size()
     

  • Method Details

    • get

      Object get(int index)
      Returns the currentCursor element at the specified position.
      Parameters:
      index - The index of the currentCursor value
      Returns:
      The currentCursor value

    • elements

      List<Object> elements()
      Returns all the currentCursor values in a list.
      Returns:
      The currentCursor values

    • size

      int size()
      Returns:
      The page of elements in the currentCursor.

    • of

      static Pageable.Cursor of(Object... elements)
      Create a currentCursor from elements.
      Parameters:
      elements - The currentCursor elements
      Returns:
      The currentCursor

    • of

      static Pageable.Cursor of(List<Object> elements)
      Create a currentCursor from elements.
      Parameters:
      elements - The currentCursor elements
      Returns:
      The currentCursor