HBASE-27206 Clean up error-prone findings in hbase-common

Author: apurtell

hbase-common/src/main/java/org/apache/hadoop/hbase/ByteBufferExtendedCell.java

@@ -60,53 +60,33 @@
  */
 @InterfaceAudience.Private
 public abstract class ByteBufferExtendedCell implements ExtendedCell {
-  /**
-   * @return The {@link ByteBuffer} containing the row bytes.
-   */
+  /** Return the {@link ByteBuffer} containing the row bytes. */
   public abstract ByteBuffer getRowByteBuffer();
 
-  /**
-   * @return Position in the {@link ByteBuffer} where row bytes start
-   */
+  /** Return the position in the {@link ByteBuffer} where row bytes start */
   public abstract int getRowPosition();
 
-  /**
-   * @return The {@link ByteBuffer} containing the column family bytes.
-   */
+  /** Return the {@link ByteBuffer} containing the column family bytes. */
   public abstract ByteBuffer getFamilyByteBuffer();
 
-  /**
-   * @return Position in the {@link ByteBuffer} where column family bytes start
-   */
+  /** Return the position in the {@link ByteBuffer} where column family bytes start */
   public abstract int getFamilyPosition();
 
-  /**
-   * @return The {@link ByteBuffer} containing the column qualifier bytes.
-   */
+  /** Return the {@link ByteBuffer} containing the column qualifier bytes. */
   public abstract ByteBuffer getQualifierByteBuffer();
 
-  /**
-   * @return Position in the {@link ByteBuffer} where column qualifier bytes start
-   */
+  /** Return the position in the {@link ByteBuffer} where column qualifier bytes start */
   public abstract int getQualifierPosition();
 
-  /**
-   * @return The {@link ByteBuffer} containing the value bytes.
-   */
+  /** Return the {@link ByteBuffer} containing the value bytes. */
   public abstract ByteBuffer getValueByteBuffer();
 
-  /**
-   * @return Position in the {@link ByteBuffer} where value bytes start
-   */
+  /** Return the position in the {@link ByteBuffer} where value bytes start */
   public abstract int getValuePosition();
 
-  /**
-   * @return The {@link ByteBuffer} containing the tag bytes.
-   */
+  /** Return the {@link ByteBuffer} containing the tag bytes. */
   public abstract ByteBuffer getTagsByteBuffer();
 
-  /**
-   * @return Position in the {@link ByteBuffer} where tag bytes start
-   */
+  /** Return the position in the {@link ByteBuffer} where tag bytes start */
   public abstract int getTagsPosition();
 }

hbase-common/src/main/java/org/apache/hadoop/hbase/ByteBufferKeyValue.java

@@ -264,7 +264,7 @@ public long heapSize() {
     if (this.buf.hasArray()) {
       return ClassSize.align(FIXED_OVERHEAD + length);
     }
-    return ClassSize.align(FIXED_OVERHEAD) + this.getSerializedSize();
+    return (long) ClassSize.align(FIXED_OVERHEAD) + this.getSerializedSize();
   }
 
   @Override

hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java

@@ -68,14 +68,10 @@ public interface Cell extends HeapSize {
    */
   byte[] getRowArray();
 
-  /**
-   * @return Array index of first row byte
-   */
+  /** Return the array index of first row byte */
   int getRowOffset();
 
-  /**
-   * @return Number of row bytes. Must be < rowArray.length - offset.
-   */
+  /** Return the number of row bytes. Must be < rowArray.length - offset. */
   short getRowLength();
 
   // 2) Family
@@ -87,14 +83,10 @@ public interface Cell extends HeapSize {
    */
   byte[] getFamilyArray();
 
-  /**
-   * @return Array index of first family byte
-   */
+  /** Return the array index of first family byte */
   int getFamilyOffset();
 
-  /**
-   * @return Number of family bytes. Must be < familyArray.length - offset.
-   */
+  /** Return the number of family bytes. Must be < familyArray.length - offset. */
   byte getFamilyLength();
 
   // 3) Qualifier
@@ -105,28 +97,24 @@ public interface Cell extends HeapSize {
    */
   byte[] getQualifierArray();
 
-  /**
-   * @return Array index of first qualifier byte
-   */
+  /** Return the array index of first qualifier byte */
   int getQualifierOffset();
 
-  /**
-   * @return Number of qualifier bytes. Must be < qualifierArray.length - offset.
-   */
+  /** Return the number of qualifier bytes. Must be < qualifierArray.length - offset. */
   int getQualifierLength();
 
   // 4) Timestamp
 
   /**
-   * @return Long value representing time at which this cell was "Put" into the row. Typically
-   *         represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.
+   * Return a long value representing time at which this cell was "Put" into the row. Typically
+   * represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.
    */
   long getTimestamp();
 
   // 5) Type
 
   /**
-   * @return The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
+   * Return the byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
    * @deprecated As of HBase-2.0. Will be removed in HBase-3.0. Use {@link #getType()}.
    */
   @Deprecated
@@ -154,19 +142,13 @@ public interface Cell extends HeapSize {
    */
   byte[] getValueArray();
 
-  /**
-   * @return Array index of first value byte
-   */
+  /** Return the array index of first value byte */
   int getValueOffset();
 
-  /**
-   * @return Number of value bytes. Must be < valueArray.length - offset.
-   */
+  /** Return the number of value bytes. Must be < valueArray.length - offset. */
   int getValueLength();
 
-  /**
-   * @return Serialized size (defaults to include tag length if has some tags).
-   */
+  /** Return the serialized size (defaults to include tag length if has some tags). */
   int getSerializedSize();
 
   /**
@@ -178,7 +160,7 @@ public interface Cell extends HeapSize {
   byte[] getTagsArray();
 
   /**
-   * @return the first offset where the tags start in the Cell
+   * Return the first offset where the tags start in the Cell
    * @deprecated As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.
    */
   @Deprecated

hbase-common/src/main/java/org/apache/hadoop/hbase/CellComparator.java

@@ -95,6 +95,7 @@ default int compareRows(byte[] leftRow, byte[] rightRow) {
   }
 
   /**
+   * Lexicographically compare two rows
    * @param row ByteBuffer that wraps a row; will read from current position and will reading all
    *            remaining; will not disturb the ByteBuffer internal state.
    * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both
@@ -111,7 +112,7 @@ default int compareRows(ByteBuffer row, Cell cell) {
   }
 
   /**
-   * Lexographically compares the two cells excluding the row part. It compares family, qualifier,
+   * Lexicographically compares the two cells excluding the row part. It compares family, qualifier,
    * timestamp and the type
    * @param leftCell  the left hand side cell
    * @param rightCell the right hand side cell
@@ -121,7 +122,7 @@ default int compareRows(ByteBuffer row, Cell cell) {
   int compareWithoutRow(Cell leftCell, Cell rightCell);
 
   /**
-   * Lexographically compares the families of the two cells
+   * Lexicographically compares the families of the two cells
    * @param leftCell  the left hand side cell
    * @param rightCell the right hand side cell
    * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both
@@ -130,7 +131,7 @@ default int compareRows(ByteBuffer row, Cell cell) {
   int compareFamilies(Cell leftCell, Cell rightCell);
 
   /**
-   * Lexographically compares the qualifiers of the two cells
+   * Lexicographically compares the qualifiers of the two cells
    * @param leftCell  the left hand side cell
    * @param rightCell the right hand side cell
    * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both
@@ -163,10 +164,9 @@ default int compareRows(ByteBuffer row, Cell cell) {
   int compareTimestamps(long leftCellts, long rightCellts);
 
   /**
-   * @return A dumbed-down, fast comparator for hbase2 base-type, the {@link ByteBufferKeyValue}.
-   *         Create an instance when you make a new memstore, when you know only BBKVs will be
-   *         passed. Do not pollute with types other than BBKV if can be helped; the Comparator will
-   *         slow.
+   * Return a dumbed-down, fast comparator for hbase2 base-type, the {@link ByteBufferKeyValue}.
+   * Create an instance when you make a new memstore, when you know only BBKVs will be passed. Do
+   * not pollute with types other than BBKV if can be helped; the Comparator will slow.
    */
-  Comparator getSimpleComparator();
+  Comparator<Cell> getSimpleComparator();
 }

hbase-common/src/main/java/org/apache/hadoop/hbase/CellComparatorImpl.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.hbase;
 
 import java.util.Comparator;
-import org.apache.hadoop.hbase.KeyValue.Type;
 import org.apache.hadoop.hbase.util.ByteBufferUtils;
 import org.apache.hadoop.hbase.util.Bytes;
 import org.apache.yetus.audience.InterfaceAudience;
@@ -691,11 +690,11 @@ public final int compareWithoutRow(final Cell left, final Cell right) {
     int rFamLength = right.getFamilyLength();
     int lQualLength = left.getQualifierLength();
     int rQualLength = right.getQualifierLength();
-    if (lFamLength + lQualLength == 0 && left.getTypeByte() == Type.Minimum.getCode()) {
+    if (lFamLength + lQualLength == 0 && left.getTypeByte() == KeyValue.Type.Minimum.getCode()) {
       // left is "bigger", i.e. it appears later in the sorted order
       return 1;
     }
-    if (rFamLength + rQualLength == 0 && right.getTypeByte() == Type.Minimum.getCode()) {
+    if (rFamLength + rQualLength == 0 && right.getTypeByte() == KeyValue.Type.Minimum.getCode()) {
       return -1;
     }
     if (lFamLength != rFamLength) {

hbase-common/src/main/java/org/apache/hadoop/hbase/CellScannable.java

@@ -26,8 +26,6 @@
  */
 @InterfaceAudience.Public
 public interface CellScannable {
-  /**
-   * @return A CellScanner over the contained {@link Cell}s
-   */
+  /** Return a CellScanner over the contained {@link Cell}s */
   CellScanner cellScanner();
 }

hbase-common/src/main/java/org/apache/hadoop/hbase/CellScanner.java

@@ -47,9 +47,7 @@
  */
 @InterfaceAudience.Public
 public interface CellScanner {
-  /**
-   * @return the current Cell which may be mutable
-   */
+  /** Return the current Cell, which may be mutable */
   Cell current();
 
   /**