You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2008/06/19 02:15:13 UTC
svn commit: r669340 - in /hadoop/hbase/trunk/src:
java/org/apache/hadoop/hbase/ java/org/apache/hadoop/hbase/client/
test/org/apache/hadoop/hbase/
Author: stack
Date: Wed Jun 18 17:15:13 2008
New Revision: 669340
URL: http://svn.apache.org/viewvc?rev=669340&view=rev
Log:
HBASE-465 Fix javadoc for all public declarations; some work toward this goal
Modified:
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/RegionHistorian.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnection.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnectionManager.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Scanner.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ScannerCallable.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ServerCallable.java
hadoop/hbase/trunk/src/test/org/apache/hadoop/hbase/TestTable.java
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/RegionHistorian.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/RegionHistorian.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/RegionHistorian.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/RegionHistorian.java Wed Jun 18 17:15:13 2008
@@ -82,10 +82,6 @@
/**
* Get the RegionHistorian Singleton instance.
- * @param c Configuration to use. Used to create an {@link HTable} homed
- * on <code>.META.</code>. The HTable instance is lazily instantiated to
- * allow for the getting and storing aside of an Historian instance even
- * in the case where <code>.META.</code> has not yet deployed.
* @return The region historian
*/
public static RegionHistorian getInstance() {
@@ -320,4 +316,4 @@
LOG.debug("Offlined");
}
}
-}
\ No newline at end of file
+}
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnection.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnection.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnection.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnection.java Wed Jun 18 17:15:13 2008
@@ -29,7 +29,8 @@
import org.apache.hadoop.hbase.ipc.HRegionInterface;
/**
- *
+ * Cluster connection.
+ * {@link HConnectionManager} manages instances of this class.
*/
public interface HConnection {
/**
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnectionManager.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnectionManager.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnectionManager.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/HConnectionManager.java Wed Jun 18 17:15:13 2008
@@ -56,7 +56,9 @@
/**
* A non-instantiable class that manages connections to multiple tables in
- * multiple HBase instances
+ * multiple HBase instances.
+ *
+ * Used by {@link HTable} and {@link HBaseAdmin}
*/
public class HConnectionManager implements HConstants {
/*
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Scanner.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Scanner.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Scanner.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Scanner.java Wed Jun 18 17:15:13 2008
@@ -24,7 +24,8 @@
import org.apache.hadoop.hbase.io.RowResult;
/**
- * Interface for client-side scanning.
+ * Interface for client-side scanning.
+ * Go to {@link HTable} to obtain instances.
*/
public interface Scanner extends Closeable, Iterable<RowResult> {
/**
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ScannerCallable.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ScannerCallable.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ScannerCallable.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ScannerCallable.java Wed Jun 18 17:15:13 2008
@@ -23,13 +23,13 @@
import java.io.IOException;
import org.apache.hadoop.hbase.HRegionInfo;
-import org.apache.hadoop.hbase.HRegionLocation;
import org.apache.hadoop.hbase.filter.RowFilterInterface;
import org.apache.hadoop.hbase.io.RowResult;
/**
- * Retryable scanner
+ * Retries scanner operations such as create, next, etc.
+ * Used by {@link Scanner}s made by {@link HTable}.
*/
public class ScannerCallable extends ServerCallable<RowResult> {
private long scannerId = -1L;
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ServerCallable.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ServerCallable.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ServerCallable.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/ServerCallable.java Wed Jun 18 17:15:13 2008
@@ -27,10 +27,8 @@
import org.apache.hadoop.hbase.ipc.HRegionInterface;
/**
- * Implements Callable, used to define the particular actions you would
- * like to take with retry logic.
+ * Abstract class that implemetns Callable, used by retryable actions.
* @param <T> the class that the ServerCallable handles
- *
*/
public abstract class ServerCallable<T> implements Callable<T> {
protected final HConnection connection;
Modified: hadoop/hbase/trunk/src/test/org/apache/hadoop/hbase/TestTable.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/test/org/apache/hadoop/hbase/TestTable.java?rev=669340&r1=669339&r2=669340&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/test/org/apache/hadoop/hbase/TestTable.java (original)
+++ hadoop/hbase/trunk/src/test/org/apache/hadoop/hbase/TestTable.java Wed Jun 18 17:15:13 2008
@@ -18,10 +18,9 @@
* limitations under the License.
*/
package org.apache.hadoop.hbase;
-import org.apache.hadoop.io.Text;
-
import java.io.IOException;
import java.util.concurrent.atomic.AtomicInteger;
+
import org.apache.hadoop.hbase.client.HBaseAdmin;
import org.apache.hadoop.hbase.client.HTable;