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

Update PageRequest.java: fix small JavaDoc issue #867

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update PageRequest.java: fix small JavaDoc issue #867

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
8 changes: 3 additions & 5 deletions api/src/main/java/jakarta/data/page/PageRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* <p>A query method of a repository may have a parameter of type
* {@code PageRequest} if its return type indicates that it may return
* multiple entities, that is, if its return type is an array type,
* {@code List}, {@code Stream}, {@link Page}, or {@link CursoredPage}.
* {@link List}, {@code Stream}, {@link Page}, or {@link CursoredPage}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe moving all of those tags to link

* The parameter of type {@code PageRequest} must occur after the method
* parameters representing regular parameters of the query itself. For
* example:</p>
Expand Down Expand Up @@ -68,7 +68,6 @@
*/
public interface PageRequest {


/**
* Creates a new page request with the given page number and with a default size of 10.
*
Expand Down Expand Up @@ -243,7 +242,6 @@ static PageRequest beforeCursor(Cursor cursor, long pageNumber, int maxPageSize,
*/
PageRequest size(int maxPageSize);


/**
* Returns an otherwise-equivalent page request with
* {@link #requestTotal()} set to {@code false}, so that
Expand All @@ -259,7 +257,7 @@ static PageRequest beforeCursor(Cursor cursor, long pageNumber, int maxPageSize,

/**
* Returns an otherwise-equivalent page request with
* {@link #requestTotal()} set to {@code false}, so that
* {@link #requestTotal()} set to {@code true}, so that
* totals will be retrieved from the database.
* @return a page request with {@link #requestTotal()}
* set to {@code true}.
Expand Down Expand Up @@ -364,4 +362,4 @@ static Cursor forKey(Object... key) {
return new PageRequestCursor(key);
}
}
}
}