From ddbc879f93b4b79dc0942a2c5d0ad0b5d8e1fd53 Mon Sep 17 00:00:00 2001
From: Michael Stack <stack@apache.org>
Date: Thu, 28 Oct 2010 22:52:44 +0000
Subject: [PATCH] Added javadoc on how Scan caching value interacts with HTable
 setting

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1028527 13f79535-47bb-0310-9956-ffa450edef68
---
 src/main/java/org/apache/hadoop/hbase/client/Scan.java | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main/java/org/apache/hadoop/hbase/client/Scan.java b/src/main/java/org/apache/hadoop/hbase/client/Scan.java
index dfec113da95..d402ad6ed90 100644
--- a/src/main/java/org/apache/hadoop/hbase/client/Scan.java
+++ b/src/main/java/org/apache/hadoop/hbase/client/Scan.java
@@ -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;