Package com.atlassian.confluence.api.model.pagination

Interface PageResponse<T>

All Superinterfaces:
Iterable<T>
All Known Subinterfaces:
NavigablePageResponse<T>, SpaceFilterAwarePageResponse<T>
All Known Implementing Classes:
ContentRestrictionsPageResponse, GraphQLPageResponse, IncrementalSyncPageResponse, NavigablePageResponseImpl, PageResponseImpl, RestList, SearchPageResponse, SpaceFilterAwarePageResponseImpl
public interface PageResponse<T> extends Iterable<T>
A response to a page request, used in pagination. Wraps a list and provides information on whether there are more results.

  • Method Details

    • getResults

      List<T> getResults()
      Returns:
      the results

    • size

      int size()
      Returns:
      the number of results in this page of results

    • hasMore

      boolean hasMore()
      Indicates whether the source has more results after this page.
      Returns:
      true if there are more results

    • getPageRequest

      PageRequest getPageRequest()
      Returns:
      the request used to produce this response

    • getTotalCount

      default Optional<Long> getTotalCount()
      Possible to return total number of result
      Returns:

    • getNextCursor

      default Cursor getNextCursor()
      Returns:
      the identifier which is used to skip results from a previous query when paginating in forward direction.
      Since:
      7.18

    • getPrevCursor

      default Cursor getPrevCursor()
      Returns:
      the identifier which is used to skip results from a previous query when paginating in backward direction.
      Since:
      7.18