svn commit: r1028527 - /hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java

[st...@apache.org]

Author: stack
Date: Thu Oct 28 22:52:44 2010
New Revision: 1028527

URL: http://svn.apache.org/viewvc?rev=1028527&view=rev
Log:
Added javadoc on how Scan caching value interacts with HTable setting

Modified:
    hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java

Modified: hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java
URL: http://svn.apache.org/viewvc/hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java?rev=1028527&r1=1028526&r2=1028527&view=diff
==============================================================================
--- hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java (original)
+++ hbase/trunk/src/main/java/org/apache/hadoop/hbase/client/Scan.java Thu Oct 28 22:52:44 2010
@@ -49,6 +49,8 @@ import java.util.TreeSet;
  * To scan everything for each row, instantiate a Scan object.
  * <p>
  * To modify scanner caching for just this scan, use {@link #setCaching(int) setCaching}.
+ * If caching is NOT set, we will use the caching value of the hosting
+ * {@link HTable}.  See {@link HTable#setScannerCaching(int)}.
  * <p>
  * To further define the scope of what to get when scanning, perform additional
  * methods as outlined below.
@@ -82,6 +84,9 @@ public class Scan implements Writable {
   private byte [] stopRow  = HConstants.EMPTY_END_ROW;
   private int maxVersions = 1;
   private int batch = -1;
+  /*
+   * -1 means no caching
+   */
   private int caching = -1;
   private boolean cacheBlocks = true;
   private Filter filter = null;