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 2009/04/23 23:46:35 UTC
svn commit: r768068 - in /hadoop/hbase/trunk: ./
src/java/org/apache/hadoop/hbase/ src/java/org/apache/hadoop/hbase/filter/
src/java/org/apache/hadoop/hbase/io/
src/java/org/apache/hadoop/hbase/io/hfile/
src/java/org/apache/hadoop/hbase/mapred/ src/jav...
Author: stack
Date: Thu Apr 23 21:46:35 2009
New Revision: 768068
URL: http://svn.apache.org/viewvc?rev=768068&view=rev
Log:
HBASE-1340 Fix new javadoc warnings
Modified:
hadoop/hbase/trunk/CHANGES.txt
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/filter/RowFilterInterface.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/RowResult.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/SequenceFile.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/hfile/HFile.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/mapred/TableInputFormatBase.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HAbstractScanner.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/LruHashMap.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/Store.java
hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.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=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Thu Apr 23 21:46:35 2009
@@ -86,6 +86,7 @@
HBASE-1058 Prevent runaway compactions
HBASE-1292 php thrift's getRow() would throw an exception if the row does
not exist (Rong-en Fan via Stack)
+ HBASE-1340 Fix new javadoc warnings (Evgeny Ryabitskiy via Stack)
IMPROVEMENTS
HBASE-1089 Add count of regions on filesystem to master UI; add percentage
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java Thu Apr 23 21:46:35 2009
@@ -59,7 +59,7 @@
/**
* The type of compression.
* @see org.apache.hadoop.io.SequenceFile.Writer
- * @deprecated Replaced by {@link Compression.Algorithm}.
+ * @deprecated
*/
@Deprecated
public static enum CompressionType {
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java Thu Apr 23 21:46:35 2009
@@ -23,6 +23,7 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import org.apache.hadoop.hbase.io.hfile.HFile;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.io.RawComparator;
@@ -227,62 +228,56 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param timestamp
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final long timestamp) {
this(Bytes.toBytes(row), timestamp);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param timestamp
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final long timestamp) {
this(row, null, timestamp, Type.Put, null);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final String column) {
this(row, column, null);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column) {
this(row, column, null);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final String column, final byte [] value) {
this(Bytes.toBytes(row), Bytes.toBytes(column), value);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column, final byte [] value) {
this(row, column, HConstants.LATEST_TIMESTAMP, value);
@@ -290,34 +285,31 @@
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param ts
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final String column, final long ts) {
this(row, column, ts, null);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param ts
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column, final long ts) {
this(row, column, ts, Type.Put);
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param timestamp
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final String column,
final long timestamp, final byte [] value) {
@@ -327,12 +319,11 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param timestamp
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column,
final long timestamp, final byte [] value) {
@@ -340,13 +331,12 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param timestamp
* @param type
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final String row, final String column,
final long timestamp, final Type type, final byte [] value) {
@@ -355,12 +345,11 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with null value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param timestamp
* @param type
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column,
final long timestamp, final Type type) {
@@ -369,13 +358,12 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param column Column with delimiter between family and qualifier
* @param timestamp
* @param type
* @param value
- * @return KeyValue structure filled with specified values.
- * @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final byte [] column,
final long timestamp, final Type type, final byte [] value) {
@@ -384,7 +372,8 @@
}
/**
- * @param row
+ * Constructs KeyValue structure filled with specified value.
+ * @param row - row key (arbitrary byte array)
* @param roffset
* @param rlength
* @param column Column with delimiter between family and qualifier
@@ -395,7 +384,6 @@
* @param value
* @param voffset
* @param vlength
- * @return KeyValue
* @throws IllegalArgumentException
*/
public KeyValue(final byte [] row, final int roffset, final int rlength,
@@ -410,7 +398,7 @@
/**
* Write KeyValue format into a byte array.
- * @param row
+ * @param row - row key (arbitrary byte array)
* @param roffset
* @param rlength
* @param column
@@ -541,7 +529,7 @@
}
/**
- * @param b Key portion of a KeyValue.
+ * @param k Key portion of a KeyValue.
* @return Key as a String.
*/
public static String keyToString(final byte [] k) {
@@ -742,7 +730,7 @@
}
/**
- * @param rowlength Pass if you have it to save on an int creation.
+ * @param rowlength - length of row.
* @return Offset into backing buffer at which the column begins
*/
public int getColumnOffset(final int rowlength) {
@@ -1031,8 +1019,8 @@
/**
* @param left
- * @param row
- * @return
+ * @param row - row key (arbitrary byte array)
+ * @return RawComparator
*/
public int compareRows(final KeyValue left, final byte [] row) {
return getRawComparator().compareRows(left.getBuffer(),
@@ -1169,7 +1157,6 @@
/**
* @return Comparator that ignores key type; useful checking deletes
- * @throws IOException
*/
public KVComparator getComparatorIgnoringType() {
KVComparator c = null;
@@ -1184,7 +1171,7 @@
}
/**
- * @param row
+ * @param row - row key (arbitrary byte array)
* @return First possible KeyValue on passed <code>row</code>
*/
public static KeyValue createFirstOnRow(final byte [] row) {
@@ -1192,8 +1179,8 @@
}
/**
- * @param row
- * @param ts
+ * @param row - row key (arbitrary byte array)
+ * @param ts - timestamp
* @return First possible key on passed <code>row</code> and timestamp.
*/
public static KeyValue createFirstOnRow(final byte [] row,
@@ -1202,8 +1189,8 @@
}
/**
- * @param row
- * @param ts
+ * @param row - row key (arbitrary byte array)
+ * @param ts - timestamp
* @return First possible key on passed <code>row</code>, column and timestamp.
*/
public static KeyValue createFirstOnRow(final byte [] row, final byte [] c,
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/filter/RowFilterInterface.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/filter/RowFilterInterface.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/filter/RowFilterInterface.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/filter/RowFilterInterface.java Thu Apr 23 21:46:35 2009
@@ -115,12 +115,13 @@
* but the rest of the row will still get through.
*
* @param rowKey row key to filter on.
- * @param colunmName column name to filter on
+ * @param columnName column name to filter on
* @param columnValue column value to filter on
* @return true if row filtered and should not be processed.
* @deprecated Use {@link #filterColumn(byte[], int, int, byte[], int, int, byte[], int, int)}
* instead.
*/
+ @Deprecated
boolean filterColumn(final byte [] rowKey, final byte [] columnName,
final byte [] columnValue);
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/RowResult.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/RowResult.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/RowResult.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/RowResult.java Thu Apr 23 21:46:35 2009
@@ -268,7 +268,7 @@
}
/**
- * @param r
+ * @param l
* @return
* TODO: This is the glue between old way of doing things and the new.
* Herein we are converting our clean KeyValues to old RowResult.
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/SequenceFile.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/SequenceFile.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/SequenceFile.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/SequenceFile.java Thu Apr 23 21:46:35 2009
@@ -1787,18 +1787,16 @@
return valClass;
}
- /** Returns true if values are compressed.
- * @return
- */
+ /** @return true if values are compressed. */
public boolean isCompressed() { return decompress; }
- /** Returns true if records are block-compressed. */
+ /** @return true if records are block-compressed. */
public boolean isBlockCompressed() { return blockCompressed; }
- /** Returns the compression codec of data in this file. */
+ /** @return the compression codec of data in this file. */
public CompressionCodec getCompressionCodec() { return codec; }
- /** Returns the metadata object of the file */
+ /** @return the metadata object of the file */
public Metadata getMetadata() {
return this.metadata;
}
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/hfile/HFile.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/hfile/HFile.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/hfile/HFile.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/hfile/HFile.java Thu Apr 23 21:46:35 2009
@@ -271,7 +271,6 @@
* @param blocksize
* @param compress
* @param c RawComparator to use.
- * @param c
* @throws IOException
*/
public Writer(final FSDataOutputStream ostream, final int blocksize,
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/mapred/TableInputFormatBase.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/mapred/TableInputFormatBase.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/mapred/TableInputFormatBase.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/mapred/TableInputFormatBase.java Thu Apr 23 21:46:35 2009
@@ -46,7 +46,7 @@
/**
* A Base for {@link TableInputFormat}s. Receives a {@link HTable}, a
- * {@link Text}[] of input columns and optionally a {@link RowFilterInterface}.
+ * byte[] of input columns and optionally a {@link RowFilterInterface}.
* Subclasses may use other TableRecordReader implementations.
* <p>
* An example of a subclass:
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HAbstractScanner.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HAbstractScanner.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HAbstractScanner.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/HAbstractScanner.java Thu Apr 23 21:46:35 2009
@@ -80,7 +80,6 @@
* Compare the column family and column key using the matchers. The first one
* that matches returns true. If no matchers are successful, return false.
*
- * @param family/store key
* @param kv KeyValue to test
* @return true if any of the matchers for the column match the column family
* and the column key.
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/LruHashMap.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/LruHashMap.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/LruHashMap.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/LruHashMap.java Thu Apr 23 21:46:35 2009
@@ -341,7 +341,7 @@
/**
* Deletes the mapping for the specified key if it exists.
*
- * @param o the key of the entry to be removed from the map
+ * @param key the key of the entry to be removed from the map
* @return the value associated with the specified key, or null
* if no mapping exists.
*/
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/Store.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/Store.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/Store.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/regionserver/Store.java Thu Apr 23 21:46:35 2009
@@ -1008,13 +1008,14 @@
* row and timestamp, but not a column name.
*
* The returned object should map column names to Cells.
- * @param origin Where to start searching. Specifies a row and timestamp.
+ * @param key - Where to start searching. Specifies a row.
* Columns are specified in following arguments.
* @param columns Can be null which means get all
* @param columnPattern Can be null.
* @param numVersions
* @param versionsCounter Can be null.
* @param keyvalues
+ * @param now - Where to start searching. Specifies a timestamp.
* @throws IOException
*/
public void getFull(KeyValue key, final NavigableSet<byte []> columns,
Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.java?rev=768068&r1=768067&r2=768068&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.java Thu Apr 23 21:46:35 2009
@@ -85,7 +85,7 @@
* }
*
* @param filter
- * @return
+ * @return RowFilter
* @throws org.apache.hadoop.hbase.rest.exception.HBaseRestException
*/
protected RowFilterInterface getRowFilter(JSONObject filter)
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=768068&r1=768067&r2=768068&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 Apr 23 21:46:35 2009
@@ -161,9 +161,9 @@
/**
* Write a long value out to the specified byte array position.
- * @param bytes the byte array
- * @param offset position in the array
- * @param b byte to write out
+ * @param tgtBytes the byte array
+ * @param tgtOffset position in the array
+ * @param srcBytes byte to write out
* @return incremented offset
*/
public static int putBytes(byte[] tgtBytes, int tgtOffset, byte[] srcBytes,
@@ -687,7 +687,7 @@
* @param offset the offset in the key you want to find
* @param length the length of the key
* @param comparator a comparator to compare.
- * @return
+ * @return index of key
*/
public static int binarySearch(byte [][]arr, byte []key, int offset, int length,
RawComparator<byte []> comparator) {