Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-22586 Javadoc Warnings related to @param tag 

Signed-off-by: Jan Hentschel <jan.hentschel@ultratendency.com>
This commit is contained in:
syedmurtazahassan 2019-07-13 16:46:19 +02:00 committed by Jan Hentschel
parent 421ae2a688
commit d26e9d04e1
No known key found for this signature in database
GPG Key ID: 5CD818B19CC299A3
17 changed files with 56 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java
View File

@ -1211,8 +1211,8 @@ public final class PrivateCellUtil {
/**
* Compare cell's row against given comparator
* @param cell
* @param comparator
* @param cell the cell to use for comparison
* @param comparator the {@link CellComparator} to use for comparison
* @return result comparing cell's row
*/
public static int compareRow(Cell cell, ByteArrayComparable comparator) {
@ -1225,8 +1225,8 @@ public final class PrivateCellUtil {
/**
* Compare cell's column family against given comparator
* @param cell
* @param comparator
* @param cell the cell to use for comparison
* @param comparator the {@link CellComparator} to use for comparison
* @return result comparing cell's column family
*/
public static int compareFamily(Cell cell, ByteArrayComparable comparator) {
@ -1240,8 +1240,8 @@ public final class PrivateCellUtil {
/**
* Compare cell's qualifier against given comparator
* @param cell
* @param comparator
* @param cell the cell to use for comparison
* @param comparator the {@link CellComparator} to use for comparison
* @return result comparing cell's qualifier
*/
public static int compareQualifier(Cell cell, ByteArrayComparable comparator) {
@ -1278,8 +1278,8 @@ public final class PrivateCellUtil {
/**
* Compare cell's value against given comparator
* @param cell
* @param comparator
* @param cell the cell to use for comparison
* @param comparator the {@link CellComparator} to use for comparison
* @return result comparing cell's value
*/
public static int compareValue(Cell cell, ByteArrayComparable comparator) {
@ -2579,7 +2579,7 @@ public final class PrivateCellUtil {
* the index block, bloom keys from the bloom blocks This byte[] is expected to be serialized in
* the KeyValue serialization format If the KeyValue (Cell's) serialization format changes this
* method cannot be used.
* @param comparator the cell comparator
* @param comparator the {@link CellComparator} to use for comparison
* @param left the cell to be compared
* @param key the serialized key part of a KeyValue
* @param offset the offset in the key byte[]
@ -2606,8 +2606,14 @@ public final class PrivateCellUtil {
* method is used both in the normal comparator and the "same-prefix" comparator. Note that we are
* assuming that row portions of both KVs have already been parsed and found identical, and we
* don't validate that assumption here.
* @param commonPrefix the length of the common prefix of the two key-values being compared,
* including row length and row
* @param comparator the {@link CellComparator} to use for comparison
* @param left the cell to be compared
* @param right the serialized key part of a key-value
* @param roffset the offset in the key byte[]
* @param rlength the length of the key byte[]
* @param rowlength the row length
* @return greater than 0 if left cell is bigger, less than 0 if right cell is bigger, 0 if both
* cells are equal
*/
static final int compareWithoutRow(CellComparator comparator, Cell left, byte[] right,
int roffset, int rlength, short rowlength) {

3
hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java
View File

@ -52,7 +52,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 {

5
hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/metrics/impl/HBaseMetrics2HadoopMetricsAdapter.java
View File

@ -138,10 +138,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);

29
hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.java
View File

@ -843,11 +843,6 @@ public class HFileOutputFormat2
/**
* Serialize column family to compression algorithm map to configuration.
* Invoked while configuring the MR job for incremental load.
*
* @param tableDescriptor to read the properties from
* @param conf to persist serialized values into
* @throws IOException
* on failure to read column family descriptors
*/
@VisibleForTesting
static Function<ColumnFamilyDescriptor, String> compressionDetails = familyDescriptor ->
@ -856,14 +851,6 @@ public class HFileOutputFormat2
/**
* Serialize column family to block size map to configuration. Invoked while
* configuring the MR job for incremental load.
*
* @param tableDescriptor
* to read the properties from
* @param conf
* to persist serialized values into
*
* @throws IOException
* on failure to read column family descriptors
*/
@VisibleForTesting
static Function<ColumnFamilyDescriptor, String> blockSizeDetails = familyDescriptor -> String
@ -872,14 +859,6 @@ public class HFileOutputFormat2
/**
* Serialize column family to bloom type map to configuration. Invoked while
* configuring the MR job for incremental load.
*
* @param tableDescriptor
* to read the properties from
* @param conf
* to persist serialized values into
*
* @throws IOException
* on failure to read column family descriptors
*/
@VisibleForTesting
static Function<ColumnFamilyDescriptor, String> bloomTypeDetails = familyDescriptor -> {
@ -893,13 +872,6 @@ public class HFileOutputFormat2
/**
* Serialize column family to data block encoding map to configuration.
* Invoked while configuring the MR job for incremental load.
*
* @param tableDescriptor
* to read the properties from
* @param conf
* to persist serialized values into
* @throws IOException
* on failure to read column family descriptors
*/
@VisibleForTesting
static Function<ColumnFamilyDescriptor, String> dataBlockEncodingDetails = familyDescriptor -> {
@ -909,5 +881,4 @@ public class HFileOutputFormat2
}
return encoding.toString();
};
}

3
hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java
View File

@ -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;

1
hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionDispatcher.java
View File

@ -95,7 +95,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) {

2
hbase-server/src/main/java/org/apache/hadoop/hbase/io/asyncfs/FanOutOneBlockAsyncDFSOutputSaslHelper.java
View File

@ -318,7 +318,7 @@ public final class FanOutOneBlockAsyncDFSOutputSaslHelper {
/**
* Creates a new SaslClientCallbackHandler.
* @param userName SASL user name
* @Param password SASL password
* @param password SASL password
*/
public SaslClientCallbackHandler(String userName, char[] password) {
this.password = password;

2
hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java
View File

@ -184,7 +184,7 @@ class NamespaceStateManager {
/**
* 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);

1
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StripeStoreFileManager.java
View File

@ -867,7 +867,6 @@ public class StripeStoreFileManager
/**
* Remove compacted files.
* @param compactedFiles Compacted files.
*/
private void removeCompactedFiles() throws IOException {
for (HStoreFile oldFile : this.compactedFiles) {

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SyncFuture.java
View File

@ -72,8 +72,6 @@ class SyncFuture {
/**
* Call this method to clear old usage and get it ready for new deploy.
* @param txid the new transaction id
* @param span current span, detached from caller. Don't forget to attach it when resuming after a
* call to {@link #get(long)}.
* @return this
*/
synchronized SyncFuture reset(long txid) {

5
hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java
View File

@ -74,10 +74,11 @@ class WALEntryStream implements Closeable {
/**
* Create an entry stream over the given queue at the given start position
* @param logQueue the queue of WAL paths
* @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 walFileLengthProvider provides the length of the WAL file
* @param serverName the server name which all WALs belong to
* @param metrics replication metrics
* @param metrics the replication metrics
* @throws IOException
*/
public WALEntryStream(PriorityBlockingQueue<Path> logQueue, Configuration conf,

9
hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java
View File

@ -192,15 +192,16 @@ public class TestActiveMasterManager {
assertTrue(t.isActiveMaster);
LOG.info("Deleting master node");
ZKUtil.deleteNode(zk, zk.getZNodePaths().masterAddressZNode);
}
/**
* 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(ZKWatcher zk,
ServerName expectedAddress)

11
hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestCatalogJanitorInMemoryStates.java
View File

@ -129,12 +129,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 RegionInfo r)
throws IOException, InterruptedException {
List<HRegionLocation> locations = new ArrayList<>();

4
hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestRegionPlacement.java
View File

@ -358,8 +358,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 {

14
hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java
View File

@ -334,7 +334,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,
@ -358,7 +363,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,

2
hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java
View File

@ -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)

4
hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java
View File

@ -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) {