You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by ji...@apache.org on 2008/09/05 00:11:19 UTC
svn commit: r692273 - in /hadoop/hbase/trunk: ./
src/java/org/apache/hadoop/hbase/
src/java/org/apache/hadoop/hbase/client/transactional/
src/java/org/apache/hadoop/hbase/ipc/
src/java/org/apache/hadoop/hbase/regionserver/
src/java/org/apache/hadoop/hb...
Author: jimk
Date: Thu Sep 4 15:11:18 2008
New Revision: 692273
URL: http://svn.apache.org/viewvc?rev=692273&view=rev
Log:
HBASE-865 Fix javadoc warnings (Rong-En Fan via Jim Kellerman)
Modified:
hadoop/hbase/trunk/CHANGES.txt
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HStoreKey.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionManager.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionalTable.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HLog.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HStore.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/Bytes.java
Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Thu Sep 4 15:11:18 2008
@@ -56,6 +56,7 @@
HBASE-832 Problem with row keys beginnig with characters < than ',' and
the region location cache
HBASE-864 Deadlock in regionserver
+ HBASE-865 Fix javadoc warnings (Rong-En Fan via Jim Kellerman)
IMPROVEMENTS
HBASE-801 When a table haven't disable, shell could response in a "user
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HStoreKey.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HStoreKey.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HStoreKey.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HStoreKey.java Thu Sep 4 15:11:18 2008
@@ -467,7 +467,7 @@
* Utility method to compare two row keys.
* This is required because of the meta delimiters.
* This is a hack.
- * @param regioninfo
+ * @param regionInfo
* @param rowA
* @param rowB
* @return value of the comparison
@@ -491,7 +491,7 @@
* Utility method to check if two row keys are equal.
* This is required because of the meta delimiters
* This is a hack
- * @param regioninfo
+ * @param regionInfo
* @param rowA
* @param rowB
* @return if it's equal
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionManager.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionManager.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionManager.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionManager.java Thu Sep 4 15:11:18 2008
@@ -65,7 +65,6 @@
* Try and commit a transaction.
*
* @param transactionState
- * @return
* @throws IOException
*/
public void tryCommit(final TransactionState transactionState)
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionalTable.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionalTable.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionalTable.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/transactional/TransactionalTable.java Thu Sep 4 15:11:18 2008
@@ -78,6 +78,7 @@
/**
* Get a single value for the specified row and column
*
+ * @param transactionState
* @param row row key
* @param column column name
* @return value for specified row/column
@@ -100,6 +101,7 @@
/**
* Get the specified number of versions of the specified row and column
*
+ * @param transactionState
* @param row - row key
* @param column - column name
* @param numVersions - number of versions to retrieve
@@ -128,6 +130,7 @@
* Get the specified number of versions of the specified row and column with
* the specified timestamp.
*
+ * @param transactionState
* @param row - row key
* @param column - column name
* @param timestamp - timestamp
@@ -157,6 +160,7 @@
/**
* Get all the data for the specified row at the latest timestamp
*
+ * @param transactionState
* @param row row key
* @return RowResult is empty if row does not exist.
* @throws IOException
@@ -169,6 +173,7 @@
/**
* Get all the data for the specified row at a specified timestamp
*
+ * @param transactionState
* @param row row key
* @param ts timestamp
* @return RowResult is empty if row does not exist.
@@ -191,6 +196,7 @@
/**
* Get selected columns for the specified row at the latest timestamp
*
+ * @param transactionState
* @param row row key
* @param columns Array of column names you want to retrieve.
* @return RowResult is empty if row does not exist.
@@ -204,6 +210,7 @@
/**
* Get selected columns for the specified row at a specified timestamp
*
+ * @param transactionState
* @param row row key
* @param columns Array of column names you want to retrieve.
* @param ts timestamp
@@ -229,8 +236,8 @@
* Delete all cells that match the passed row and whose timestamp is equal-to
* or older than the passed timestamp.
*
+ * @param transactionState
* @param row Row to update
- * @param column name of column whose value is to be deleted
* @param ts Delete all cells of the same timestamp or older.
* @throws IOException
*/
@@ -253,6 +260,7 @@
* Get a scanner on the current table starting at first row. Return the
* specified columns.
*
+ * @param transactionState
* @param columns columns to scan. If column name is a column family, all
* columns of the specified column family are returned. Its also possible to
* pass a regex in the column qualifier. A column qualifier is judged to be a
@@ -271,6 +279,7 @@
* Get a scanner on the current table starting at the specified row. Return
* the specified columns.
*
+ * @param transactionState
* @param columns columns to scan. If column name is a column family, all
* columns of the specified column family are returned. Its also possible to
* pass a regex in the column qualifier. A column qualifier is judged to be a
@@ -290,6 +299,7 @@
* Get a scanner on the current table starting at the specified row. Return
* the specified columns.
*
+ * @param transactionState
* @param columns columns to scan. If column name is a column family, all
* columns of the specified column family are returned. Its also possible to
* pass a regex in the column qualifier. A column qualifier is judged to be a
@@ -310,6 +320,7 @@
* Get a scanner on the current table starting at the specified row. Return
* the specified columns.
*
+ * @param transactionState
* @param columns columns to scan. If column name is a column family, all
* columns of the specified column family are returned. Its also possible to
* pass a regex in the column qualifier. A column qualifier is judged to be a
@@ -331,6 +342,7 @@
* Get a scanner on the current table starting at the specified row. Return
* the specified columns.
*
+ * @param transactionState
* @param columns columns to scan. If column name is a column family, all
* columns of the specified column family are returned. Its also possible to
* pass a regex in the column qualifier. A column qualifier is judged to be a
@@ -354,6 +366,7 @@
/**
* Commit a BatchUpdate to the table.
*
+ * @param transactionState
* @param batchUpdate
* @throws IOException
*/
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java Thu Sep 4 15:11:18 2008
@@ -162,7 +162,6 @@
* Commit the transaction.
*
* @param transactionId
- * @return
*/
public void commit(final byte[] regionName, long transactionId)
throws IOException;
@@ -171,7 +170,6 @@
* Abort the transaction.
*
* @param transactionId
- * @return
*/
public void abort(final byte[] regionName, long transactionId)
throws IOException;
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HLog.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HLog.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HLog.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HLog.java Thu Sep 4 15:11:18 2008
@@ -314,6 +314,8 @@
/**
* This is a convenience method that computes a new filename with a given
* file-number.
+ * @param fn
+ * @return Path
*/
public Path computeFilename(final long fn) {
return new Path(dir, HLOG_DATFILE + fn);
@@ -433,8 +435,7 @@
/** Append an entry to the log.
*
- * @param regionName
- * @param tableName
+ * @param regionInfo
* @param row
* @param logEdit
* @throws IOException
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java Thu Sep 4 15:11:18 2008
@@ -398,22 +398,16 @@
* appropriate log info for this HRegion. If there is a previous log file
* (implying that the HRegion has been written-to before), then read it from
* the supplied path.
- * @param basedir qualified path of directory where region should be located,
- * usually the table directory.
* @param fs is the filesystem.
* @param conf is global configuration settings.
* @param regionInfo - HRegionInfo that describes the region
- * @param initialFiles If there are initial files (implying that the HRegion
* is new), then read them from the supplied path.
* @param flushListener an object that implements CacheFlushListener or null
- * @param reporter Call on a period so hosting server can report we're
* making progress to master -- otherwise master might think region deploy
* failed. Can be null.
- * @throws IOException
*/
public HRegion(Path basedir, HLog log, FileSystem fs, HBaseConfiguration conf,
- HRegionInfo regionInfo,
- FlushRequester flushListener) {
+ HRegionInfo regionInfo, FlushRequester flushListener) {
this.basedir = basedir;
this.log = log;
this.fs = fs;
@@ -1171,6 +1165,7 @@
* @param row
* @param columns Array of columns you'd like to retrieve. When null, get all.
* @param ts
+ * @param lockid
* @return Map<columnName, Cell> values
* @throws IOException
*/
@@ -1360,6 +1355,7 @@
/**
* @param b
+ * @param writeToWAL
* @throws IOException
*/
public void batchUpdate(BatchUpdate b, boolean writeToWAL) throws IOException {
@@ -1369,6 +1365,7 @@
/**
* @param b
+ * @param lockid
* @throws IOException
*/
public void batchUpdate(BatchUpdate b, Integer lockid) throws IOException {
@@ -1377,7 +1374,8 @@
/**
* @param b
- * @param writeToWal if true, then we write this update to the log
+ * @param lockid
+ * @param writeToWAL if true, then we write this update to the log
* @throws IOException
*/
public void batchUpdate(BatchUpdate b, Integer lockid, boolean writeToWAL)
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HStore.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HStore.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HStore.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HStore.java Thu Sep 4 15:11:18 2008
@@ -1357,8 +1357,8 @@
* Get <code>versions</code> of keys matching the origin key's
* row/column/timestamp and those of an older vintage.
* @param origin Where to start searching.
- * @param numVersions How many versions to return. Pass
- * {@link HConstants.ALL_VERSIONS} to retrieve all.
+ * @param versions How many versions to return. Pass
+ * {@link HConstants#ALL_VERSIONS} to retrieve all.
* @param now
* @return Matching keys.
* @throws IOException
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/Bytes.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/Bytes.java?rev=692273&r1=692272&r2=692273&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/Bytes.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/Bytes.java Thu Sep 4 15:11:18 2008
@@ -180,7 +180,7 @@
/**
* @param b
* @return Runs {@link WritableComparator#hashBytes(byte[], int)} on the
- * passed in array. This method is what {@link Text} and
+ * passed in array. This method is what {@link org.apache.hadoop.io.Text} and
* {@link ImmutableBytesWritable} use calculating hash code.
*/
public static int hashCode(final byte [] b) {
@@ -189,8 +189,9 @@
/**
* @param b
+ * @param length
* @return Runs {@link WritableComparator#hashBytes(byte[], int)} on the
- * passed in array. This method is what {@link Text} and
+ * passed in array. This method is what {@link org.apache.hadoop.io.Text} and
* {@link ImmutableBytesWritable} use calculating hash code.
*/
public static int hashCode(final byte [] b, final int length) {
@@ -208,6 +209,7 @@
/**
* @param b
+ * @param length
* @return A hash of <code>b</code> as an Integer that can be used as key in
* Maps.
*/