From 7ea9c9bcda825e9b4c950f03055d5cf63ec02a77 Mon Sep 17 00:00:00 2001 From: Alex Newman Date: Mon, 23 Jan 2012 09:50:27 -0800 Subject: [PATCH] HBASE-5240. HBase internalscanner.next javadoc doesn't imply whether or not results are appended or not --- .../hadoop/hbase/regionserver/InternalScanner.java | 13 ++++++++----- 1 files changed, 8 insertions(+), 5 deletions(-) diff --git src/main/java/org/apache/hadoop/hbase/regionserver/InternalScanner.java src/main/java/org/apache/hadoop/hbase/regionserver/InternalScanner.java index 0f5f36c..22b630e 100644 --- src/main/java/org/apache/hadoop/hbase/regionserver/InternalScanner.java +++ src/main/java/org/apache/hadoop/hbase/regionserver/InternalScanner.java @@ -38,20 +38,23 @@ import java.util.List; * were specified. If so, we need to ignore the timestamp to ensure that we get * all the family members, as they may have been last updated at different * times. + * */ public interface InternalScanner extends Closeable { /** - * Grab the next row's worth of values. - * @param results return output array + * Grab the next row's worth of values and append them to results. + * @param results return output array in which results are appended to. * @return true if more rows exist after this one, false if scanner is done * @throws IOException e */ public boolean next(List results) throws IOException; /** - * Grab the next row's worth of values with a limit on the number of values - * to return. - * @param result return output array + * Grab the next row's worth of values and append them to results with a + * limit on the number of additional values in which to append onto. Note, + * the result array may contain more than [limit] values, if there were + * already results in the list. + * @param result return output array in which results are appended to. * @param limit limit on row count to get * @return true if more rows exist after this one, false if scanner is done * @throws IOException e -- 1.7.4.4