HBASE-27220 Apply the spotless format change in HBASE-27208 to our code base

Signed-off-by: Andrew Purtell <[email protected]>

Author: Apache9

hbase-asyncfs/src/main/java/org/apache/hadoop/hbase/io/asyncfs/AsyncFSOutput.java

@@ -89,8 +89,6 @@ public interface AsyncFSOutput extends Closeable {
   @Override
   void close() throws IOException;
 
-  /**
-   * @return byteSize success synced to underlying filesystem.
-   */
+  /** Returns byteSize success synced to underlying filesystem. */
   long getSyncedLength();
 }

hbase-asyncfs/src/main/java/org/apache/hadoop/hbase/util/RecoverLeaseFSUtils.java

@@ -186,9 +186,7 @@ private static boolean recoverLease(final DistributedFileSystem dfs, final int n
     return recovered;
   }
 
-  /**
-   * @return Detail to append to any log message around lease recovering.
-   */
+  /** Returns Detail to append to any log message around lease recovering. */
   private static String getLogMessageDetail(final int nbAttempt, final Path p,
     final long startWaiting) {
     return "attempt=" + nbAttempt + " on file=" + p + " after "

hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/FavoredStochasticBalancer.java

@@ -87,9 +87,7 @@ protected List<CandidateGenerator> createCandidateGenerators() {
     return fnPickers;
   }
 
-  /**
-   * @return any candidate generator in random
-   */
+  /** Returns any candidate generator in random */
   @Override
   protected CandidateGenerator getRandomGenerator() {
     return candidateGenerators.get(ThreadLocalRandom.current().nextInt(candidateGenerators.size()));

hbase-client/src/main/java/org/apache/hadoop/hbase/CatalogFamilyFormat.java

@@ -398,9 +398,7 @@ public static boolean hasMergeRegions(Cell[] cells) {
     return false;
   }
 
-  /**
-   * @return True if the column in <code>cell</code> matches the regex 'info:merge.*'.
-   */
+  /** Returns True if the column in <code>cell</code> matches the regex 'info:merge.*'. */
   public static boolean isMergeQualifierPrefix(Cell cell) {
     // Check to see if has family and that qualifier starts with the merge qualifier 'merge'
     return CellUtil.matchingFamily(cell, HConstants.CATALOG_FAMILY)

hbase-client/src/main/java/org/apache/hadoop/hbase/ClientMetaTableAccessor.java

@@ -382,9 +382,7 @@ public boolean visit(Result r) throws IOException {
 
     abstract void add(Result r);
 
-    /**
-     * @return Collected results; wait till visits complete to collect all possible results
-     */
+    /** Returns Collected results; wait till visits complete to collect all possible results */
     List<T> getResults() {
       return this.results;
     }

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterId.java

@@ -45,9 +45,7 @@ public ClusterId(final String uuid) {
     this.id = uuid;
   }
 
-  /**
-   * @return The clusterid serialized using pb w/ pb magic prefix
-   */
+  /** Returns The clusterid serialized using pb w/ pb magic prefix */
   public byte[] toByteArray() {
     return ProtobufUtil.prependPBMagic(convert().toByteArray());
   }
@@ -74,9 +72,7 @@ public static ClusterId parseFrom(final byte[] bytes) throws DeserializationExce
     }
   }
 
-  /**
-   * @return A pb instance to represent this instance.
-   */
+  /** Returns A pb instance to represent this instance. */
   public ClusterIdProtos.ClusterId convert() {
     ClusterIdProtos.ClusterId.Builder builder = ClusterIdProtos.ClusterId.newBuilder();
     return builder.setClusterId(this.id).build();

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterMetrics.java

@@ -69,38 +69,26 @@
 @InterfaceAudience.Public
 public interface ClusterMetrics {
 
-  /**
-   * @return the HBase version string as reported by the HMaster
-   */
+  /** Returns the HBase version string as reported by the HMaster */
   @Nullable
   String getHBaseVersion();
 
-  /**
-   * @return the names of region servers on the dead list
-   */
+  /** Returns the names of region servers on the dead list */
   List<ServerName> getDeadServerNames();
 
-  /**
-   * @return the names of region servers on the decommissioned list
-   */
+  /** Returns the names of region servers on the decommissioned list */
   List<ServerName> getDecommissionedServerNames();
 
-  /**
-   * @return the names of region servers on the live list
-   */
+  /** Returns the names of region servers on the live list */
   Map<ServerName, ServerMetrics> getLiveServerMetrics();
 
-  /**
-   * @return the number of regions deployed on the cluster
-   */
+  /** Returns the number of regions deployed on the cluster */
   default int getRegionCount() {
     return getLiveServerMetrics().entrySet().stream()
       .mapToInt(v -> v.getValue().getRegionMetrics().size()).sum();
   }
 
-  /**
-   * @return the number of requests since last report
-   */
+  /** Returns the number of requests since last report */
   default long getRequestCount() {
     return getLiveServerMetrics().entrySet().stream()
       .flatMap(v -> v.getValue().getRegionMetrics().values().stream())
@@ -114,9 +102,7 @@ default long getRequestCount() {
   @Nullable
   ServerName getMasterName();
 
-  /**
-   * @return the names of backup masters
-   */
+  /** Returns the names of backup masters */
   List<ServerName> getBackupMasterNames();
 
   @InterfaceAudience.Private
@@ -147,9 +133,7 @@ default long getLastMajorCompactionTimestamp(byte[] regionName) {
 
   List<ServerName> getServersName();
 
-  /**
-   * @return the average cluster load
-   */
+  /** Returns the average cluster load */
   default double getAverageLoad() {
     int serverSize = getLiveServerMetrics().size();
     if (serverSize == 0) {

hbase-client/src/main/java/org/apache/hadoop/hbase/CoprocessorEnvironment.java

@@ -28,19 +28,19 @@
 @InterfaceStability.Evolving
 public interface CoprocessorEnvironment<C extends Coprocessor> {
 
-  /** @return the Coprocessor interface version */
+  /** Returns the Coprocessor interface version */
   int getVersion();
 
-  /** @return the HBase version as a string (e.g. "0.21.0") */
+  /** Returns the HBase version as a string (e.g. "0.21.0") */
   String getHBaseVersion();
 
-  /** @return the loaded coprocessor instance */
+  /** Returns the loaded coprocessor instance */
   C getInstance();
 
-  /** @return the priority assigned to the loaded coprocessor */
+  /** Returns the priority assigned to the loaded coprocessor */
   int getPriority();
 
-  /** @return the load sequence number */
+  /** Returns the load sequence number */
   int getLoadSequence();
 
   /**
@@ -49,8 +49,6 @@ public interface CoprocessorEnvironment<C extends Coprocessor> {
    */
   Configuration getConfiguration();
 
-  /**
-   * @return the classloader for the loaded coprocessor instance
-   */
+  /** Returns the classloader for the loaded coprocessor instance */
   ClassLoader getClassLoader();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/HBaseServerException.java

@@ -63,9 +63,7 @@ public void setServerOverloaded(boolean serverOverloaded) {
     this.serverOverloaded = serverOverloaded;
   }
 
-  /**
-   * @return True if server was considered overloaded when exception was thrown
-   */
+  /** Returns True if server was considered overloaded when exception was thrown */
   public boolean isServerOverloaded() {
     return serverOverloaded;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetrics.java

@@ -28,44 +28,28 @@
 @InterfaceAudience.Public
 public interface RegionMetrics {
 
-  /**
-   * @return the region name
-   */
+  /** Returns the region name */
   byte[] getRegionName();
 
-  /**
-   * @return the number of stores
-   */
+  /** Returns the number of stores */
   int getStoreCount();
 
-  /**
-   * @return the number of storefiles
-   */
+  /** Returns the number of storefiles */
   int getStoreFileCount();
 
-  /**
-   * @return the total size of the storefiles
-   */
+  /** Returns the total size of the storefiles */
   Size getStoreFileSize();
 
-  /**
-   * @return the memstore size
-   */
+  /** Returns the memstore size */
   Size getMemStoreSize();
 
-  /**
-   * @return the number of read requests made to region
-   */
+  /** Returns the number of read requests made to region */
   long getReadRequestCount();
 
-  /**
-   * @return the number of write requests made to region
-   */
+  /** Returns the number of write requests made to region */
   long getWriteRequestCount();
 
-  /**
-   * @return the number of coprocessor service requests made to region
-   */
+  /** Returns the number of coprocessor service requests made to region */
   public long getCpRequestCount();
 
   /**
@@ -76,16 +60,12 @@ default long getRequestCount() {
     return getReadRequestCount() + getWriteRequestCount() + getCpRequestCount();
   }
 
-  /**
-   * @return the region name as a string
-   */
+  /** Returns the region name as a string */
   default String getNameAsString() {
     return Bytes.toStringBinary(getRegionName());
   }
 
-  /**
-   * @return the number of filtered read requests made to region
-   */
+  /** Returns the number of filtered read requests made to region */
   long getFilteredReadRequestCount();
 
   /**
@@ -96,29 +76,19 @@ default String getNameAsString() {
    */
   Size getStoreFileIndexSize();
 
-  /**
-   * @return The current total size of root-level indexes for the region
-   */
+  /** Returns The current total size of root-level indexes for the region */
   Size getStoreFileRootLevelIndexSize();
 
-  /**
-   * @return The total size of all index blocks, not just the root level
-   */
+  /** Returns The total size of all index blocks, not just the root level */
   Size getStoreFileUncompressedDataIndexSize();
 
-  /**
-   * @return The total size of all Bloom filter blocks, not just loaded into the block cache
-   */
+  /** Returns The total size of all Bloom filter blocks, not just loaded into the block cache */
   Size getBloomFilterSize();
 
-  /**
-   * @return the total number of cells in current compaction
-   */
+  /** Returns the total number of cells in current compaction */
   long getCompactingCellCount();
 
-  /**
-   * @return the number of already compacted kvs in current compaction
-   */
+  /** Returns the number of already compacted kvs in current compaction */
   long getCompactedCellCount();
 
   /**
@@ -127,29 +97,19 @@ default String getNameAsString() {
    */
   long getCompletedSequenceId();
 
-  /**
-   * @return completed sequence id per store.
-   */
+  /** Returns completed sequence id per store. */
   Map<byte[], Long> getStoreSequenceId();
 
-  /**
-   * @return the uncompressed size of the storefiles
-   */
+  /** Returns the uncompressed size of the storefiles */
   Size getUncompressedStoreFileSize();
 
-  /**
-   * @return the data locality of region in the regionserver.
-   */
+  /** Returns the data locality of region in the regionserver. */
   float getDataLocality();
 
-  /**
-   * @return the timestamp of the oldest hfile for any store of this region.
-   */
+  /** Returns the timestamp of the oldest hfile for any store of this region. */
   long getLastMajorCompactionTimestamp();
 
-  /**
-   * @return the reference count for the stores of this region
-   */
+  /** Returns the reference count for the stores of this region */
   int getStoreRefCount();
 
   /**
@@ -164,9 +124,7 @@ default String getNameAsString() {
    */
   float getDataLocalityForSsd();
 
-  /**
-   * @return the data at local weight of this region in the regionserver
-   */
+  /** Returns the data at local weight of this region in the regionserver */
   long getBlocksLocalWeight();
 
   /**
@@ -175,13 +133,9 @@ default String getNameAsString() {
    */
   long getBlocksLocalWithSsdWeight();
 
-  /**
-   * @return the block total weight of this region
-   */
+  /** Returns the block total weight of this region */
   long getBlocksTotalWeight();
 
-  /**
-   * @return the compaction state of this region
-   */
+  /** Returns the compaction state of this region */
   CompactionState getCompactionState();
 }