GitHub-Spring/spring-data-commons
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-data-commons.git synced 2026-05-02 19:22:27 +01:00
Code Issues Projects Releases Wiki Activity

Clarify Javadoc for FallbackPageable in PageableHandlerMethodArgumentResolverSupport.

Browse Source 
Closes #2551
This commit is contained in:
Mark Paluch
2022-02-17 14:33:59 +01:00
parent b92e2695c5
commit 6e4bdeb4a5
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/org/springframework/data/web/PageableHandlerMethodArgumentResolverSupport.java
+5 -8
View File
@@ -63,14 +63,11 @@ public abstract class PageableHandlerMethodArgumentResolverSupport {
private boolean oneIndexedParameters = false;
/**
* Configures the {@link Pageable} to be used as fallback in case no {@link PageableDefault} or
* {@link PageableDefault} (the latter only supported in legacy mode) can be found at the method parameter to be
* resolved.
* Configures the {@link Pageable} to be used as fallback in case no {@link PageableDefault} can be found at the
* method parameter to be resolved.
* <p>
* If you set this to {@literal Optional#empty()}, be aware that you controller methods will get {@literal null}
* handed into them in case no {@link Pageable} data can be found in the request. Note, that doing so will require you
* supply bot the page <em>and</em> the size parameter with the requests as there will be no default for any of the
* parameters available.
* If you set this to {@literal Pageable#unpaged()}, be aware that your controller methods will get an {@code unpaged}
* instance handed into them in case no {@link Pageable} data can be found in the request.
*
* @param fallbackPageable the {@link Pageable} to be used as general fallback.
*/
@@ -254,7 +251,7 @@ public abstract class PageableHandlerMethodArgumentResolverSupport {
private static Pageable getDefaultPageRequestFrom(MethodParameter parameter, PageableDefault defaults) {
Integer defaultPageNumber = defaults.page();
int defaultPageNumber = defaults.page();
Integer defaultPageSize = getSpecificPropertyOrDefaultFromValue(defaults, "size");
if (defaultPageSize < 1) {