You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by ja...@apache.org on 2019/07/13 15:50:09 UTC
[hbase] branch branch-1.4 updated: HBASE-22586 Javadoc Warnings
related to @param tag
This is an automated email from the ASF dual-hosted git repository.
janh pushed a commit to branch branch-1.4
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-1.4 by this push:
new 8709bdf HBASE-22586 Javadoc Warnings related to @param tag
8709bdf is described below
commit 8709bdf798aa58dde92a99328e231cf30e3c2c9c
Author: syedmurtazahassan <sy...@gmail.com>
AuthorDate: Sat Jul 13 16:46:19 2019 +0200
HBASE-22586 Javadoc Warnings related to @param tag
Signed-off-by: Jan Hentschel <ja...@ultratendency.com>
---
.../apache/hadoop/hbase/util/ClassLoaderTestHelper.java | 3 ++-
.../metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java | 5 ++---
.../main/java/org/apache/hadoop/hbase/HealthChecker.java | 3 ++-
.../hbase/errorhandling/ForeignExceptionDispatcher.java | 1 -
.../hadoop/hbase/namespace/NamespaceStateManager.java | 7 ++++---
.../hadoop/hbase/regionserver/StripeStoreFileManager.java | 1 -
.../hbase/replication/regionserver/WALEntryStream.java | 5 ++---
.../hadoop/hbase/master/TestActiveMasterManager.java | 13 +++++++------
.../hbase/master/TestCatalogJanitorInMemoryStates.java | 11 +++++------
.../apache/hadoop/hbase/master/TestRegionPlacement.java | 4 ++--
.../org/apache/hadoop/hbase/procedure/TestZKProcedure.java | 14 ++++++++++++--
.../hbase/regionserver/EncodedSeekPerformanceTest.java | 2 +-
.../hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java | 4 +++-
13 files changed, 42 insertions(+), 31 deletions(-)
diff --git a/hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java b/hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java
index 79d2f3f..afefe14 100644
--- a/hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java
+++ b/hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java
@@ -54,7 +54,8 @@ public class ClassLoaderTestHelper {
* Jar a list of files into a jar archive.
*
* @param archiveFile the target jar archive
- * @param tobejared a list of files to be jared
+ * @param tobeJared a list of files to be jared
+ * @return true if a jar archive is build, false otherwise
*/
private static boolean createJarArchive(File archiveFile, File[] tobeJared) {
try {
diff --git a/hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java b/hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java
index ec4a1a7..8223df9 100644
--- a/hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java
+++ b/hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java
@@ -137,10 +137,9 @@ public class HBaseMetrics2HadoopMetricsAdapter {
/**
* Add Histogram value-distribution data to a Hadoop-Metrics2 record building.
*
- * @param builder A Hadoop-Metrics2 record builder.
* @param name A base name for this record.
- * @param desc A description for this record.
- * @param snapshot The distribution of measured values.
+ * @param histogram A histogram to measure distribution of values.
+ * @param builder A Hadoop-Metrics2 record builder.
*/
private void addHistogram(String name, Histogram histogram, MetricsRecordBuilder builder) {
MutableHistogram.snapshot(name, EMPTY_STRING, histogram, builder, true);
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java
index 530a323..2356395 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java
@@ -54,7 +54,8 @@ class HealthChecker {
/**
* Initialize.
*
- * @param configuration
+ * @param location the location of the health script
+ * @param timeout the timeout to be used for the health script
*/
public void init(String location, long timeout) {
this.healthCheckScript = location;
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionDispatcher.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionDispatcher.java
index f5fc979..4425075 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionDispatcher.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionDispatcher.java
@@ -96,7 +96,6 @@ public class ForeignExceptionDispatcher implements ForeignExceptionListener, For
/**
* Sends an exception to all listeners.
- * @param message human readable message passed to the listener
* @param e {@link ForeignException} containing the cause. Can be null.
*/
private void dispatch(ForeignException e) {
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java
index 07d784c..d9dcebf 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java
@@ -108,7 +108,7 @@ class NamespaceStateManager extends ZooKeeperListener {
}
return true;
}
-
+
/**
* Check and update region count for an existing table. To handle scenarios like restore snapshot
* @param TableName name of the table for region count needs to be checked and updated
@@ -117,7 +117,7 @@ class NamespaceStateManager extends ZooKeeperListener {
* namespace
* @throws IOException Signals that an I/O exception has occurred.
*/
- synchronized void checkAndUpdateNamespaceRegionCount(TableName name, int incr)
+ synchronized void checkAndUpdateNamespaceRegionCount(TableName name, int incr)
throws IOException {
String namespace = name.getNamespaceAsString();
NamespaceDescriptor nspdesc = getNamespaceDescriptor(namespace);
@@ -185,7 +185,8 @@ class NamespaceStateManager extends ZooKeeperListener {
/**
* Delete the namespace state.
- * @param An instance of NamespaceTableAndRegionInfo
+ *
+ * @param namespace the name of the namespace to delete
*/
void deleteNamespace(String namespace) {
this.nsStateCache.remove(namespace);
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StripeStoreFileManager.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StripeStoreFileManager.java
index 5f13985..9f8a3b0 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StripeStoreFileManager.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StripeStoreFileManager.java
@@ -838,7 +838,6 @@ public class StripeStoreFileManager
/**
* Remove compacted files.
- * @param compactedFiles Compacted files.
*/
private void removeCompactedFiles() throws IOException {
for (StoreFile oldFile : this.compactedFiles) {
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java
index 3942d23..dc54418 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java
@@ -81,10 +81,9 @@ public class WALEntryStream implements Iterator<Entry>, Closeable, Iterable<Entr
/**
* Create an entry stream over the given queue at the given start position
* @param logQueue the queue of WAL paths
- * @param fs {@link FileSystem} to use to create {@link Reader} for this stream
- * @param conf {@link Configuration} to use to create {@link Reader} for this stream
+ * @param conf the {@link Configuration} to use to create {@link Reader} for this stream
* @param startPosition the position in the first WAL to start reading at
- * @param metrics replication metrics
+ * @param metrics the replication metrics
* @throws IOException
*/
public WALEntryStream(PriorityBlockingQueue<Path> logQueue, FileSystem fs, Configuration conf,
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java
index 406e532..428ff1e 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java
@@ -133,7 +133,7 @@ public class TestActiveMasterManager {
ClusterStatusTracker clusterStatusTracker =
ms1.getClusterStatusTracker();
clusterStatusTracker.setClusterUp();
- activeMasterManager.blockUntilBecomingActiveMaster(100,
+ activeMasterManager.blockUntilBecomingActiveMaster(100,
Mockito.mock(MonitoredTask.class));
assertTrue(activeMasterManager.clusterHasActiveMaster.get());
assertMaster(zk, firstMasterAddress);
@@ -183,15 +183,16 @@ public class TestActiveMasterManager {
assertTrue(t.isActiveMaster);
LOG.info("Deleting master node");
+
ZKUtil.deleteNode(zk, zk.getMasterAddressZNode());
}
/**
* Assert there is an active master and that it has the specified address.
- * @param zk
- * @param thisMasterAddress
- * @throws KeeperException
- * @throws IOException
+ * @param zk single Zookeeper watcher
+ * @param expectedAddress the expected address of the master
+ * @throws KeeperException unexpected Zookeeper exception
+ * @throws IOException if an IO problem is encountered
*/
private void assertMaster(ZooKeeperWatcher zk,
ServerName expectedAddress)
@@ -267,7 +268,7 @@ public class TestActiveMasterManager {
@Override
public void abort(final String msg, final Throwable t) {}
-
+
@Override
public boolean isAborted() {
return false;
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestCatalogJanitorInMemoryStates.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestCatalogJanitorInMemoryStates.java
index 301ff6b..a2fb7d6 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestCatalogJanitorInMemoryStates.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestCatalogJanitorInMemoryStates.java
@@ -162,12 +162,11 @@ public class TestCatalogJanitorInMemoryStates {
});
}
- /*
- * Splits a region
- * @param t Region to split.
- * @return List of region locations
- * @throws IOException, InterruptedException
- */
+ /**
+ * Splits a region
+ * @param r Region to split.
+ * @return List of region locations
+ */
private List<HRegionLocation> splitRegion(final HRegionInfo r)
throws IOException, InterruptedException {
List<HRegionLocation> locations = new ArrayList<>();
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestRegionPlacement.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestRegionPlacement.java
index 312b3be..3b1448a 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestRegionPlacement.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestRegionPlacement.java
@@ -352,8 +352,8 @@ public class TestRegionPlacement {
/**
* Verify the meta has updated to the latest assignment plan
- * @param plan
- * @throws IOException
+ * @param expectedPlan the region assignment plan
+ * @throws IOException if an IO problem is encountered
*/
private void verifyMETAUpdated(FavoredNodesPlan expectedPlan)
throws IOException {
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java
index 3798ab7..bf959d7 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java
@@ -329,7 +329,12 @@ public class TestZKProcedure {
/**
* Wait for the coordinator task to complete, and verify all the mocks
- * @param task to wait on
+ * @param proc the {@link Procedure} to execute
+ * @param prepare the mock prepare
+ * @param commit the mock commit
+ * @param cleanup the mock cleanup
+ * @param finish the mock finish
+ * @param opHasError the operation error state
* @throws Exception on unexpected failure
*/
private void waitAndVerifyProc(Procedure proc, VerificationMode prepare,
@@ -353,7 +358,12 @@ public class TestZKProcedure {
/**
* Wait for the coordinator task to complete, and verify all the mocks
- * @param task to wait on
+ * @param op the {@link Subprocedure} to use
+ * @param prepare the mock prepare
+ * @param commit the mock commit
+ * @param cleanup the mock cleanup
+ * @param finish the mock finish
+ * @param opHasError the operation error state
* @throws Exception on unexpected failure
*/
private void waitAndVerifySubproc(Subprocedure op, VerificationMode prepare,
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java
index 12c36f8..814be61 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java
@@ -143,7 +143,7 @@ public class EncodedSeekPerformanceTest {
/**
* @param path Path to the HFile which will be used.
- * @param encoders List of encoders which will be used for tests.
+ * @param encodings the data block encoding algorithms to use
* @throws IOException if there is a bug while reading from disk
*/
public void runTests(Path path, DataBlockEncoding[] encodings)
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java
index 8626280..36a2882 100644
--- a/hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java
@@ -101,7 +101,9 @@ public class ProcessBasedLocalHBaseCluster {
/**
* Constructor. Modifies the passed configuration.
- * @param hbaseHome the top directory of the HBase source tree
+ * @param conf the {@link Configuration} to use
+ * @param numDataNodes the number of data nodes
+ * @param numRegionServers the number of region servers
*/
public ProcessBasedLocalHBaseCluster(Configuration conf,
int numDataNodes, int numRegionServers) {