From 8d54cae54df36e088b1c74740e8cc7d15b0ff3e1 Mon Sep 17 00:00:00 2001 From: Christoph Strobl Date: Tue, 10 May 2022 16:15:41 +0200 Subject: [PATCH] Polishing. Update Query javadoc. Original Pull Request: #3999 --- .../data/mongodb/core/query/Query.java | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java index 0a43d27f3..a608a59a9 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java @@ -122,9 +122,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. */ public Query skip(long skip) { @@ -133,10 +134,10 @@ public class Query { } /** - * 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) { @@ -313,7 +314,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 */ @@ -322,7 +323,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. */