[03/12] accumulo git commit: ACCUMULO-3959 More accurate BatchScanner javadoc

[el...@apache.org]

ACCUMULO-3959 More accurate BatchScanner javadoc


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/01dd7e32
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/01dd7e32
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/01dd7e32

Branch: refs/heads/master
Commit: 01dd7e32e864c7359f8b289f1434c9d9a5c154d4
Parents: dcd27de
Author: Dylan Hutchison <dh...@mit.edu>
Authored: Sun Aug 23 22:19:47 2015 -0400
Committer: Dylan Hutchison <dh...@mit.edu>
Committed: Sun Aug 23 22:19:47 2015 -0400

----------------------------------------------------------------------
 .../apache/accumulo/core/client/BatchScanner.java    | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/01dd7e32/core/src/main/java/org/apache/accumulo/core/client/BatchScanner.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/client/BatchScanner.java b/core/src/main/java/org/apache/accumulo/core/client/BatchScanner.java
index 47e6db1..bd7eb88 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/BatchScanner.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/BatchScanner.java
@@ -16,19 +16,20 @@
  */
 package org.apache.accumulo.core.client;
 
+import org.apache.accumulo.core.data.Range;
+
 import java.util.Collection;
 import java.util.concurrent.TimeUnit;
 
-import org.apache.accumulo.core.data.Range;
-
 /**
  * Implementations of BatchScanner support efficient lookups of many ranges in accumulo.
+ * BatchScanners are also appropriate for large, single ranges,
+ * as a BatchScanner will break those ranges up into separate RPCs
+ * provided the range spans more than one tablet
+ * and there are sufficiently many scan threads available.
  *
- * Use this when looking up lots of ranges and you expect each range to contain a small amount of data. Also only use this when you do not care about the
- * returned data being in sorted order.
- *
- * If you want to lookup a few ranges and expect those ranges to contain a lot of data, then use the Scanner instead. Also, the Scanner will return data in
- * sorted order, this will not.
+ * Only use this when you do not care about returned data being in sorted order.
+ * Use a {@link Scanner} instead when sorted order is important.
  *
  * A BatchScanner instance will use no more threads than provided in the construction of the BatchScanner
  * implementation. Multiple invocations of <code>iterator()</code> will all share the same resources of the instance.