Skip to content

Commit 3f9cd4c

Browse files
committed
Polishing.
Tweak Javadoc wording, revert visibility changes, add missing Override annotations. See #2882
1 parent 4e528db commit 3f9cd4c

File tree

3 files changed

+36
-29
lines changed

3 files changed

+36
-29
lines changed

src/main/java/org/springframework/data/domain/AbstractPageRequest.java

+12-5
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ public abstract class AbstractPageRequest implements Pageable, Serializable {
3434
private final int pageSize;
3535

3636
/**
37-
* Creates a new {@link AbstractPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return
38-
* the first pageNumber.
37+
* Creates a new {@link AbstractPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will
38+
* return the first pageNumber.
3939
*
40-
* @param pageNumber must not be less than zero.
41-
* @param pageSize must not be less than one.
40+
* @param pageNumber zero-based page number, must not be negative.
41+
* @param pageSize the size of the page to be returned, must be greater than 0.
4242
*/
43-
protected AbstractPageRequest(int pageNumber, int pageSize) {
43+
public AbstractPageRequest(int pageNumber, int pageSize) {
4444

4545
if (pageNumber < 0) {
4646
throw new IllegalArgumentException("Page index must not be less than zero");
@@ -54,26 +54,32 @@ protected AbstractPageRequest(int pageNumber, int pageSize) {
5454
this.pageSize = pageSize;
5555
}
5656

57+
@Override
5758
public int getPageSize() {
5859
return pageSize;
5960
}
6061

62+
@Override
6163
public int getPageNumber() {
6264
return pageNumber;
6365
}
6466

67+
@Override
6568
public long getOffset() {
6669
return (long) pageNumber * (long) pageSize;
6770
}
6871

72+
@Override
6973
public boolean hasPrevious() {
7074
return pageNumber > 0;
7175
}
7276

77+
@Override
7378
public Pageable previousOrFirst() {
7479
return hasPrevious() ? previous() : first();
7580
}
7681

82+
@Override
7783
public abstract Pageable next();
7884

7985
/**
@@ -83,6 +89,7 @@ public Pageable previousOrFirst() {
8389
*/
8490
public abstract Pageable previous();
8591

92+
@Override
8693
public abstract Pageable first();
8794

8895
@Override

src/main/java/org/springframework/data/domain/PageRequest.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ public class PageRequest extends AbstractPageRequest {
3737
/**
3838
* Creates a new {@link PageRequest} with sort parameters applied.
3939
*
40-
* @param pageNumber zero-based pageNumber index, must not be negative.
41-
* @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0.
40+
* @param pageNumber zero-based page number, must not be negative.
41+
* @param pageSize the size of the page to be returned, must be greater than 0.
4242
* @param sort must not be {@literal null}, use {@link Sort#unsorted()} instead.
4343
*/
4444
protected PageRequest(int pageNumber, int pageSize, Sort sort) {
@@ -53,8 +53,8 @@ protected PageRequest(int pageNumber, int pageSize, Sort sort) {
5353
/**
5454
* Creates a new unsorted {@link PageRequest}.
5555
*
56-
* @param pageNumber zero-based pageNumber index, must not be negative.
57-
* @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0.
56+
* @param pageNumber zero-based page number, must not be negative.
57+
* @param pageSize the size of the page to be returned, must be greater than 0.
5858
* @since 2.0
5959
*/
6060
public static PageRequest of(int pageNumber, int pageSize) {
@@ -64,8 +64,8 @@ public static PageRequest of(int pageNumber, int pageSize) {
6464
/**
6565
* Creates a new {@link PageRequest} with sort parameters applied.
6666
*
67-
* @param pageNumber zero-based pageNumber index.
68-
* @param pageSize the pageSize of the pageNumber to be returned.
67+
* @param pageNumber zero-based page number, must not be negative.
68+
* @param pageSize the size of the page to be returned, must be greater than 0.
6969
* @param sort must not be {@literal null}, use {@link Sort#unsorted()} instead.
7070
* @since 2.0
7171
*/
@@ -76,8 +76,8 @@ public static PageRequest of(int pageNumber, int pageSize, Sort sort) {
7676
/**
7777
* Creates a new {@link PageRequest} with sort direction and properties applied.
7878
*
79-
* @param pageNumber zero-based pageNumber index, must not be negative.
80-
* @param pageSize the pageSize of the pageNumber to be returned, must be greater than 0.
79+
* @param pageNumber zero-based page number, must not be negative.
80+
* @param pageSize the size of the page to be returned, must be greater than 0.
8181
* @param direction must not be {@literal null}.
8282
* @param properties must not be {@literal null}.
8383
* @since 2.0

src/main/java/org/springframework/data/querydsl/QPageRequest.java

+16-16
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ public class QPageRequest extends AbstractPageRequest {
3838
private final QSort sort;
3939

4040
/**
41-
* Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the first
42-
* pageNumber.
41+
* Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the
42+
* first pageNumber.
4343
*
44-
* @param pageNumber must not be negative.
45-
* @param pageSize must be greater or equal to 0.
44+
* @param pageNumber zero-based page number, must not be negative.
45+
* @param pageSize the size of the page to be returned, must be greater than 0.
4646
* @deprecated since 2.1, use {@link #of(int, int)} instead.
4747
*/
4848
@Deprecated
@@ -53,8 +53,8 @@ public QPageRequest(int pageNumber, int pageSize) {
5353
/**
5454
* Creates a new {@link QPageRequest} with the given {@link OrderSpecifier}s applied.
5555
*
56-
* @param pageNumber must not be negative.
57-
* @param pageSize must be greater or equal to 0.
56+
* @param pageNumber zero-based page number, must not be negative.
57+
* @param pageSize the size of the page to be returned, must be greater than 0.
5858
* @param orderSpecifiers must not be {@literal null} or empty;
5959
* @deprecated since 2.1, use {@link #of(int, int, OrderSpecifier...)} instead.
6060
*/
@@ -66,8 +66,8 @@ public QPageRequest(int pageNumber, int pageSize, OrderSpecifier<?>... orderSpec
6666
/**
6767
* Creates a new {@link QPageRequest} with sort parameters applied.
6868
*
69-
* @param pageNumber must not be negative.
70-
* @param pageSize must be greater or equal to 0.
69+
* @param pageNumber zero-based page number, must not be negative.
70+
* @param pageSize the size of the page to be returned, must be greater than 0.
7171
* @param sort must not be {@literal null}.
7272
* @deprecated since 2.1, use {@link #of(int, int, QSort)} instead.
7373
*/
@@ -82,11 +82,11 @@ public QPageRequest(int pageNumber, int pageSize, QSort sort) {
8282
}
8383

8484
/**
85-
* Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the first
86-
* pageNumber.
85+
* Creates a new {@link QPageRequest}. Pages are zero indexed, thus providing 0 for {@code pageNumber} will return the
86+
* first pageNumber.
8787
*
88-
* @param pageNumber must not be negative.
89-
* @param pageSize must be greater or equal to 0.
88+
* @param pageNumber zero-based page number, must not be negative.
89+
* @param pageSize the size of the page to be returned, must be greater than 0.
9090
* @since 2.1
9191
*/
9292
public static QPageRequest of(int pageNumber, int pageSize) {
@@ -96,8 +96,8 @@ public static QPageRequest of(int pageNumber, int pageSize) {
9696
/**
9797
* Creates a new {@link QPageRequest} with the given {@link OrderSpecifier}s applied.
9898
*
99-
* @param pageNumber must not be negative.
100-
* @param pageSize must be greater or equal to 0.
99+
* @param pageNumber zero-based page number, must not be negative.
100+
* @param pageSize the size of the page to be returned, must be greater than 0.
101101
* @param orderSpecifiers must not be {@literal null} or empty;
102102
* @since 2.1
103103
*/
@@ -108,8 +108,8 @@ public static QPageRequest of(int pageNumber, int pageSize, OrderSpecifier<?>...
108108
/**
109109
* Creates a new {@link QPageRequest} with sort parameters applied.
110110
*
111-
* @param pageNumber must not be negative.
112-
* @param pageSize must be greater or equal to 0.
111+
* @param pageNumber zero-based page number, must not be negative.
112+
* @param pageSize the size of the page to be returned, must be greater than 0.
113113
* @param sort must not be {@literal null}.
114114
* @since 2.1
115115
*/

0 commit comments

Comments
 (0)