ACCUMULO-3934 Add extra documentation to BatchScanner WRT threadpool sharing
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/68dd7501 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/68dd7501 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/68dd7501 Branch: refs/heads/1.7 Commit: 68dd750133fc472d10708ec7960ff53e634b25ca Parents: 7ec6665 Author: Josh Elser <els...@apache.org> Authored: Tue Jul 7 22:31:27 2015 -0400 Committer: Josh Elser <els...@apache.org> Committed: Tue Jul 7 22:31:27 2015 -0400 ---------------------------------------------------------------------- .../main/java/org/apache/accumulo/core/client/BatchScanner.java | 4 ++++ 1 file changed, 4 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/68dd7501/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 39f96f5..47e6db1 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 @@ -29,6 +29,10 @@ import org.apache.accumulo.core.data.Range; * * 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. + * + * 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. + * A new BatchScanner instance should be created to use allocate additional threads. */ public interface BatchScanner extends ScannerBase {
