Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve javadoc on PagingParams #451

Merged
merged 1 commit into from
Nov 17, 2020
Merged

Improve javadoc on PagingParams #451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/main/java/org/kiwiproject/spring/data/PagingParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
* Note also that if there is only one sort, only the primary sort and direction should be set. If the primary
* sort is not defined, but the secondary sort is defined, then the behavior is up to the implementation. e.g. it
* may choose to ignore the secondary sort entirely, or it might treat the secondary sort as the primary one.
* <p>
* A page number and page size limit should always be specified. Sorting parameters are optional, but as mentioned
* above, the primary sort property and direction should be specified when only one level of sorting is required.
* Both primary and secondary sort can be specified when two levels are required.
*
* @implNote Our specific needs have never required more than primary and second sorts, which is why there are only
* these two levels.
Expand Down