From a11e78dca5111512417a29154bfceaab99e70d8b Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Thu, 20 Jul 2023 15:36:11 +0200 Subject: [PATCH] Polishing. Tweak Javadoc wording, revert visibility changes, add missing Override annotations. See #2882 --- .../data/domain/AbstractPageRequest.java | 17 +++++++--- .../data/domain/PageRequest.java | 16 +++++----- .../data/querydsl/QPageRequest.java | 32 +++++++++---------- 3 files changed, 36 insertions(+), 29 deletions(-) diff --git a/src/main/java/org/springframework/data/domain/AbstractPageRequest.java b/src/main/java/org/springframework/data/domain/AbstractPageRequest.java index d2432690a..08b2c631c 100644 --- a/src/main/java/org/springframework/data/domain/AbstractPageRequest.java +++ b/src/main/java/org/springframework/data/domain/AbstractPageRequest.java @@ -34,13 +34,13 @@ public abstract class AbstractPageRequest implements Pageable, Serializable { private final int pageSize; /** - * Creates a new {@link AbstractPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return - * the first pageNumber. + * Creates a new {@link AbstractPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will + * return the first pageNumber. * - * @param pageNumber must not be less than zero. - * @param pageSize must not be less than one. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. */ - protected AbstractPageRequest(int pageNumber, int pageSize) { + public AbstractPageRequest(int pageNumber, int pageSize) { if (pageNumber < 0) { throw new IllegalArgumentException("Page index must not be less than zero"); @@ -54,26 +54,32 @@ public abstract class AbstractPageRequest implements Pageable, Serializable { this.pageSize = pageSize; } + @Override public int getPageSize() { return pageSize; } + @Override public int getPageNumber() { return pageNumber; } + @Override public long getOffset() { return (long) pageNumber * (long) pageSize; } + @Override public boolean hasPrevious() { return pageNumber > 0; } + @Override public Pageable previousOrFirst() { return hasPrevious() ? previous() : first(); } + @Override public abstract Pageable next(); /** @@ -83,6 +89,7 @@ public abstract class AbstractPageRequest implements Pageable, Serializable { */ public abstract Pageable previous(); + @Override public abstract Pageable first(); @Override diff --git a/src/main/java/org/springframework/data/domain/PageRequest.java b/src/main/java/org/springframework/data/domain/PageRequest.java index 4b1b3add5..ba38c7f7c 100644 --- a/src/main/java/org/springframework/data/domain/PageRequest.java +++ b/src/main/java/org/springframework/data/domain/PageRequest.java @@ -37,8 +37,8 @@ public class PageRequest extends AbstractPageRequest { /** * Creates a new {@link PageRequest} with sort parameters applied. * - * @param pageNumber zero-based pageNumber index, must not be negative. - * @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param sort must not be {@literal null}, use {@link Sort#unsorted()} instead. */ protected PageRequest(int pageNumber, int pageSize, Sort sort) { @@ -53,8 +53,8 @@ public class PageRequest extends AbstractPageRequest { /** * Creates a new unsorted {@link PageRequest}. * - * @param pageNumber zero-based pageNumber index, must not be negative. - * @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @since 2.0 */ public static PageRequest of(int pageNumber, int pageSize) { @@ -64,8 +64,8 @@ public class PageRequest extends AbstractPageRequest { /** * Creates a new {@link PageRequest} with sort parameters applied. * - * @param pageNumber zero-based pageNumber index. - * @param pageSize the pageSize of the pageNumber to be returned. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param sort must not be {@literal null}, use {@link Sort#unsorted()} instead. * @since 2.0 */ @@ -76,8 +76,8 @@ public class PageRequest extends AbstractPageRequest { /** * Creates a new {@link PageRequest} with sort direction and properties applied. * - * @param pageNumber zero-based pageNumber index, must not be negative. - * @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param direction must not be {@literal null}. * @param properties must not be {@literal null}. * @since 2.0 diff --git a/src/main/java/org/springframework/data/querydsl/QPageRequest.java b/src/main/java/org/springframework/data/querydsl/QPageRequest.java index 5355fa78e..2ff3195f3 100644 --- a/src/main/java/org/springframework/data/querydsl/QPageRequest.java +++ b/src/main/java/org/springframework/data/querydsl/QPageRequest.java @@ -38,11 +38,11 @@ public class QPageRequest extends AbstractPageRequest { private final QSort sort; /** - * Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the first - * pageNumber. + * Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the + * first pageNumber. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @deprecated since 2.1, use {@link #of(int, int)} instead. */ @Deprecated @@ -53,8 +53,8 @@ public class QPageRequest extends AbstractPageRequest { /** * Creates a new {@link QPageRequest} with the given {@link OrderSpecifier}s applied. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param orderSpecifiers must not be {@literal null} or empty; * @deprecated since 2.1, use {@link #of(int, int, OrderSpecifier...)} instead. */ @@ -66,8 +66,8 @@ public class QPageRequest extends AbstractPageRequest { /** * Creates a new {@link QPageRequest} with sort parameters applied. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param sort must not be {@literal null}. * @deprecated since 2.1, use {@link #of(int, int, QSort)} instead. */ @@ -82,11 +82,11 @@ public class QPageRequest extends AbstractPageRequest { } /** - * Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the first - * pageNumber. + * Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the + * first pageNumber. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @since 2.1 */ public static QPageRequest of(int pageNumber, int pageSize) { @@ -96,8 +96,8 @@ public class QPageRequest extends AbstractPageRequest { /** * Creates a new {@link QPageRequest} with the given {@link OrderSpecifier}s applied. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param orderSpecifiers must not be {@literal null} or empty; * @since 2.1 */ @@ -108,8 +108,8 @@ public class QPageRequest extends AbstractPageRequest { /** * Creates a new {@link QPageRequest} with sort parameters applied. * - * @param pageNumber must not be negative. - * @param pageSize must be greater or equal to 0. + * @param pageNumber zero-based page number, must not be negative. + * @param pageSize the size of the page to be returned, must be greater than 0. * @param sort must not be {@literal null}. * @since 2.1 */