Skip to content

Commit 47864e0

Browse files
Polishing.
Update Query javadoc. Original Pull Request: #3999
1 parent ed83c76 commit 47864e0

File tree

1 file changed

+9
-7
lines changed
  • spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query

1 file changed

+9
-7
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java

+9-7
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,10 @@ public Field fields() {
124124
}
125125

126126
/**
127-
* Set number of documents to skip before returning results.
127+
* Set number of documents to skip before returning results. Use {@literal zero} or a {@literal negative} value to
128+
* avoid skipping.
128129
*
129-
* @param skip
130+
* @param skip number of documents to skip. Use {@literal zero} or a {@literal negative} value to avoid skipping.
130131
* @return this.
131132
*/
132133
public Query skip(long skip) {
@@ -135,10 +136,10 @@ public Query skip(long skip) {
135136
}
136137

137138
/**
138-
* Limit the number of returned documents to {@code limit}.
139-
* If limit chosen is 0 it returns all documents
139+
* Limit the number of returned documents to {@code limit}. A {@literal zero} or {@literal negative} value is
140+
* considered as unlimited.
140141
*
141-
* @param limit
142+
* @param limit number of documents to return. Use {@literal zero} or {@literal negative} for unlimited.
142143
* @return this.
143144
*/
144145
public Query limit(int limit) {
@@ -315,7 +316,7 @@ public boolean isSorted() {
315316
}
316317

317318
/**
318-
* Get the number of documents to skip.
319+
* Get the number of documents to skip. {@literal Zero} or a {@literal negative} value indicates no skip.
319320
*
320321
* @return number of documents to skip
321322
*/
@@ -324,7 +325,8 @@ public long getSkip() {
324325
}
325326

326327
/**
327-
* Get the maximum number of documents to be return.
328+
* Get the maximum number of documents to be return. {@literal Zero} or a {@literal negative} value indicates no
329+
* limit.
328330
*
329331
* @return number of documents to return.
330332
*/

0 commit comments

Comments
 (0)