From c09b84d89fb5d7f724e93a1934158e042759aafe Mon Sep 17 00:00:00 2001
From: =?utf8?q?Leif=20=C3=85strand?= <legioth@gmail.com>
Date: Wed, 8 Feb 2017 16:34:29 +0200
Subject: [PATCH] Clarify javadocs for query values not used for counting
 (#8509)

Fixes #8489
---
 .../main/java/com/vaadin/data/provider/Query.java   | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/server/src/main/java/com/vaadin/data/provider/Query.java b/server/src/main/java/com/vaadin/data/provider/Query.java
index abf905658c..e0f1a331b9 100644
--- a/server/src/main/java/com/vaadin/data/provider/Query.java
+++ b/server/src/main/java/com/vaadin/data/provider/Query.java
@@ -93,7 +93,8 @@ public class Query<T, F> implements Serializable {
     }
 
     /**
-     * Gets the first index of items to fetch.
+     * Gets the first index of items to fetch. The offset is only used when
+     * fetching items, but not when counting the number of available items.
      *
      * @return offset for data request
      */
@@ -102,7 +103,8 @@ public class Query<T, F> implements Serializable {
     }
 
     /**
-     * Gets the limit of items to fetch.
+     * Gets the limit of items to fetch. The limit is only used when fetching
+     * items, but not when counting the number of available items.
      * <p>
      * <strong>Note: </strong>It is possible that
      * {@code offset + limit > item count}
@@ -115,7 +117,8 @@ public class Query<T, F> implements Serializable {
 
     /**
      * Gets the sorting for items to fetch. This list of sort orders is used for
-     * sorting backends.
+     * sorting backends. The sort orders are only used when fetching items, but
+     * not when counting the number of available items.
      * <p>
      * <strong>Note: </strong> Sort orders and in-memory sorting are mutually
      * exclusive. If the {@link DataProvider} handles one, it should ignore the
@@ -137,7 +140,9 @@ public class Query<T, F> implements Serializable {
     }
 
     /**
-     * Gets the comparator for sorting in-memory data.
+     * Gets the comparator for sorting in-memory data. The comparator is only
+     * used when fetching items, but not when counting the number of available
+     * items.
      * <p>
      * <strong>Note: </strong> Sort orders and in-memory sorting are mutually
      * exclusive. If the {@link DataProvider} handles one, it should ignore the
-- 
2.39.5