Skip to content

API Reference (Javadoc)

The library ships a javadoc.jar with every release to Maven Central. Two ways to read it:

Online (javadoc.io)

javadoc.io mirrors Javadoc for every artifact on Maven Central — no setup required.

The first visit to a new version takes a moment while javadoc.io fetches the jar from Maven Central; subsequent visits are cached.

In your IDE

Once you've added the dependency, IntelliJ IDEA, Eclipse, and VS Code (with Java extensions) all fetch the javadoc.jar from Maven Central automatically. Hover over any @AutoPaginate, @KeysetPaginate, PageResponse, KeysetPage, etc. to see the Javadoc inline.

If your IDE doesn't show docs, force a refresh:

./gradlew dependencies --refresh-dependencies

mvn dependency:resolve -Dclassifier=javadoc

Key entry points

A short map of where to start when reading the API:

Class What it does
@AutoPaginate Controller-method annotation for offset pagination
@KeysetPaginate Controller-method annotation for cursor pagination
PageResponse Offset response envelope
KeysetPage Keyset response envelope
KeysetRequest Resolved cursor + page-size for a keyset request
CursorCodec Encode/decode keyset cursors (HMAC-SHA256 signing)
PageResponseFactory SPI for replacing the default response envelope
ReactivePagingSupport Reactor helper for blocking MyBatis calls
EasyPagingProperties All easy-paging.* configuration keys