HBASE-16376 Scan#setBatch(int) javadoc update WRT partial results

Signed-off-by: Enis Soztutar <enis@apache.org>
This commit is contained in:
Josh Elser 2016-08-21 22:40:42 -04:00 committed by Enis Soztutar
parent cbfd6eecbd
commit 1ca849269d
1 changed files with 7 additions and 1 deletions

View File

@ -479,7 +479,13 @@ public class Scan extends Query {
} }
/** /**
* Set the maximum number of values to return for each call to next() * Set the maximum number of values to return for each call to next().
* Callers should be aware that invoking this method with any value
* is equivalent to calling {@link #setAllowPartialResults(boolean)}
* with a value of {@code true}; partial results may be returned if
* this method is called. Use {@link #setMaxResultSize(long)}} to
* limit the size of a Scan's Results instead.
*
* @param batch the maximum number of values * @param batch the maximum number of values
*/ */
public Scan setBatch(int batch) { public Scan setBatch(int batch) {