Browse Source

Polishing.

Update Query javadoc.

Original Pull Request: #3999
pull/4125/head
Christoph Strobl 4 years ago
parent
commit
47864e0cf9
No known key found for this signature in database
GPG Key ID: 8CC1AB53391458C8
  1. 16
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java

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

@ -124,9 +124,10 @@ public class Query {
} }
/** /**
* 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. * @return this.
*/ */
public Query skip(long skip) { public Query skip(long skip) {
@ -135,10 +136,10 @@ public class Query {
} }
/** /**
* Limit the number of returned documents to {@code limit}. * Limit the number of returned documents to {@code limit}. A {@literal zero} or {@literal negative} value is
* If limit chosen is 0 it returns all documents * considered as unlimited.
* *
* @param limit * @param limit number of documents to return. Use {@literal zero} or {@literal negative} for unlimited.
* @return this. * @return this.
*/ */
public Query limit(int limit) { public Query limit(int limit) {
@ -315,7 +316,7 @@ public class Query {
} }
/** /**
* 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 * @return number of documents to skip
*/ */
@ -324,7 +325,8 @@ public class Query {
} }
/** /**
* 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. * @return number of documents to return.
*/ */

Loading…
Cancel
Save