Skip to content

Commit

Permalink
Polishing.
Browse files Browse the repository at this point in the history
Update Query javadoc.

Original Pull Request: #3999
  • Loading branch information
christophstrobl committed May 10, 2022
1 parent 286ff1c commit 3a6d6bb
Showing 1 changed file with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,10 @@ public Field fields() {
}

/**
* Set number of documents to skip before returning results.
* Set number of documents to skip before returning results. Use {@literal zero} or a {@literal negative} value to
* avoid skipping.
*
* @param skip
* @param skip number of documents to skip. Use {@literal zero} or a {@literal negative} value to avoid skipping.
* @return this.
*/
public Query skip(long skip) {
Expand All @@ -135,10 +136,10 @@ public Query skip(long skip) {
}

/**
* Limit the number of returned documents to {@code limit}.
* If limit chosen is 0 it returns all documents
* Limit the number of returned documents to {@code limit}. A {@literal zero} or {@literal negative} value is
* considered as unlimited.
*
* @param limit
* @param limit number of documents to return. Use {@literal zero} or {@literal negative} for unlimited.
* @return this.
*/
public Query limit(int limit) {
Expand Down Expand Up @@ -315,7 +316,7 @@ public boolean isSorted() {
}

/**
* Get the number of documents to skip.
* Get the number of documents to skip. {@literal Zero} or a {@literal negative} value indicates no skip.
*
* @return number of documents to skip
*/
Expand All @@ -324,7 +325,8 @@ public long getSkip() {
}

/**
* Get the maximum number of documents to be return.
* Get the maximum number of documents to be return. {@literal Zero} or a {@literal negative} value indicates no
* limit.
*
* @return number of documents to return.
*/
Expand Down

0 comments on commit 3a6d6bb

Please sign in to comment.