Package com.shri.restinpeace.annotation.pagination


package com.shri.restinpeace.annotation.pagination
  • Class
    Description
    Declares that a method's response is paginated - following a next-page pointer automatically, extracting each page's items into a Page<T>, instead of leaving the fetch-extract-repeat loop to hand-written code.
    How the client advances to the next page on its own, when pointerSource = NONE (no server-given pointer at all) - offset or page-number arithmetic instead of following an extracted value.
    Marks a parameter - already annotated @QueryParam/@PathParam/ @HeaderParam/@Body - as the carrier a @Paginated fetch re-populates with the freshly extracted next-page pointer before every subsequent call.
    Where one particular @Paginated signal comes from - reused across pointerSource, hasMoreSource, totalSource, and totalPagesSource (one enum, four uses, not four renamed near-duplicates) per docs/design/pagination-helper.md ยง6.1.
    Whether a @Paginated method's extracted next-page pointer is a complete URL to follow verbatim, or a bare value to re-inject into the next request via a @PaginationCursor carrier.