HBASE-22725 Remove all remaining Javadoc warnings

Signed-off-by: stack <stack@apache.org>
Signed-off-by: Jan Hentschel <jan.hentschel@ultratendency.com>
This commit is contained in:
syedmurtazahassan 2019-08-11 21:48:08 +02:00 committed by Jan Hentschel
parent ef887e5292
commit 15c903b3f8
13 changed files with 55 additions and 43 deletions

View File

@ -76,7 +76,7 @@ public class BufferedMutatorParams implements Cloneable {
} }
/** /**
* @deprecated Since 2.3.0, will be removed in 4.0.0. Use {@link #operationTimeout()} * @deprecated Since 2.3.0, will be removed in 4.0.0. Use {@link #operationTimeout(int)}
*/ */
@Deprecated @Deprecated
public BufferedMutatorParams opertationTimeout(final int operationTimeout) { public BufferedMutatorParams opertationTimeout(final int operationTimeout) {

View File

@ -431,9 +431,10 @@ class SimpleRequestController implements RequestController {
* regions. 3) check the total concurrent tasks. 4) check the concurrent * regions. 3) check the total concurrent tasks. 4) check the concurrent
* tasks for server. * tasks for server.
* *
* @param loc * @param loc the destination of data
* @param heapSizeOfRow * @param heapSizeOfRow the data size
* @return either Include {@link ReturnCode} or Skip {@link ReturnCode} * @return either Include {@link RequestController.ReturnCode} or skip
* {@link RequestController.ReturnCode}
*/ */
@Override @Override
public ReturnCode canTakeOperation(HRegionLocation loc, long heapSizeOfRow) { public ReturnCode canTakeOperation(HRegionLocation loc, long heapSizeOfRow) {

View File

@ -176,9 +176,9 @@ public interface Table extends Closeable {
* @throws IOException if a remote or network exception occurs. * @throws IOException if a remote or network exception occurs.
* @since 0.90.0 * @since 0.90.0
* @apiNote {@link #put(List)} runs pre-flight validations on the input list on client. * @apiNote {@link #put(List)} runs pre-flight validations on the input list on client.
* Currently {@link #get(List)} doesn't run any validations on the client-side, currently there * Currently {@link #get(List)} doesn't run any validations on the client-side,
* is no need, but this may change in the future. An * currently there is no need, but this may change in the future. An
* {@link IllegalArgumentException} will be thrown in this case. * {@link IllegalArgumentException} will be thrown in this case.
*/ */
default Result[] get(List<Get> gets) throws IOException { default Result[] get(List<Get> gets) throws IOException {
throw new NotImplementedException("Add an implementation!"); throw new NotImplementedException("Add an implementation!");
@ -284,10 +284,10 @@ public interface Table extends Closeable {
* that have not be successfully applied. * that have not be successfully applied.
* @since 0.20.1 * @since 0.20.1
* @apiNote In 3.0.0 version, the input list {@code deletes} will no longer be modified. Also, * @apiNote In 3.0.0 version, the input list {@code deletes} will no longer be modified. Also,
* {@link #put(List)} runs pre-flight validations on the input list on client. Currently * {@link #put(List)} runs pre-flight validations on the input list on client. Currently
* {@link #delete(List)} doesn't run validations on the client, there is no need currently, * {@link #delete(List)} doesn't run validations on the client, there is no need
* but this may change in the future. An * {@link IllegalArgumentException} will be thrown * currently, but this may change in the future. An * {@link IllegalArgumentException}
* in this case. * will be thrown in this case.
*/ */
default void delete(List<Delete> deletes) throws IOException { default void delete(List<Delete> deletes) throws IOException {
throw new NotImplementedException("Add an implementation!"); throw new NotImplementedException("Add an implementation!");

View File

@ -39,7 +39,7 @@ public abstract class Batch {
* the implementations {@link Batch.Call#call(Object)} method will be invoked * the implementations {@link Batch.Call#call(Object)} method will be invoked
* with a proxy to each region's coprocessor {@link com.google.protobuf.Service} implementation. * with a proxy to each region's coprocessor {@link com.google.protobuf.Service} implementation.
* </p> * </p>
* @see org.apache.hadoop.hbase.client.coprocessor * @see org.apache.hadoop.hbase.client.coprocessor.Batch
* @see org.apache.hadoop.hbase.client.Table#coprocessorService(byte[]) * @see org.apache.hadoop.hbase.client.Table#coprocessorService(byte[])
* @see org.apache.hadoop.hbase.client.Table#coprocessorService(Class, byte[], byte[], * @see org.apache.hadoop.hbase.client.Table#coprocessorService(Class, byte[], byte[],
* org.apache.hadoop.hbase.client.coprocessor.Batch.Call) * org.apache.hadoop.hbase.client.coprocessor.Batch.Call)

View File

@ -267,9 +267,10 @@ public class ExportSnapshot extends AbstractHBaseTool implements Tool {
return new Path(outputArchive, path); return new Path(outputArchive, path);
} }
@SuppressWarnings("checkstyle:linelength")
/** /**
* Used by TestExportSnapshot to test for retries when failures happen. * Used by TestExportSnapshot to test for retries when failures happen.
* Failure is injected in {@link #copyFile(Context, SnapshotFileInfo, Path)}. * Failure is injected in {@link #copyFile(Mapper.Context, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotFileInfo, Path)}.
*/ */
private void injectTestFailure(final Context context, final SnapshotFileInfo inputInfo) private void injectTestFailure(final Context context, final SnapshotFileInfo inputInfo)
throws IOException { throws IOException {

View File

@ -1529,11 +1529,11 @@ public class BucketCache implements BlockCache, HeapSize {
/** /**
* Defined the map as {@link ConcurrentHashMap} explicitly here, because in * Defined the map as {@link ConcurrentHashMap} explicitly here, because in
* {@link RAMCache#get(BlockCacheKey)} and * {@link RAMCache#get(BlockCacheKey)} and
* {@link RAMCache#putIfAbsent(BlockCacheKey, RAMQueueEntry)} , we need to guarantee the * {@link RAMCache#putIfAbsent(BlockCacheKey, BucketCache.RAMQueueEntry)} , we need to
* atomicity of map#computeIfPresent(key, func) and map#putIfAbsent(key, func). Besides, the * guarantee the atomicity of map#computeIfPresent(key, func) and map#putIfAbsent(key, func).
* func method can execute exactly once only when the key is present(or absent) and under the * Besides, the func method can execute exactly once only when the key is present(or absent)
* lock context. Otherwise, the reference count of block will be messed up. Notice that the * and under the lock context. Otherwise, the reference count of block will be messed up.
* {@link java.util.concurrent.ConcurrentSkipListMap} can not guarantee that. * Notice that the {@link java.util.concurrent.ConcurrentSkipListMap} can not guarantee that.
*/ */
final ConcurrentHashMap<BlockCacheKey, RAMQueueEntry> delegate = new ConcurrentHashMap<>(); final ConcurrentHashMap<BlockCacheKey, RAMQueueEntry> delegate = new ConcurrentHashMap<>();

View File

@ -99,7 +99,7 @@ public class RegionStateNode implements Comparable<RegionStateNode> {
/** /**
* Updated whenever a call to {@link #setRegionLocation(ServerName)} or * Updated whenever a call to {@link #setRegionLocation(ServerName)} or
* {@link #setState(State, State...)}. * {@link #setState(RegionState.State, RegionState.State...)}.
*/ */
private volatile long lastUpdate = 0; private volatile long lastUpdate = 0;

View File

@ -4047,7 +4047,7 @@ public class HRegion implements HeapSize, PropagatingConfigurationObserver, Regi
* a batch are stored with highest durability specified of for all operations in a batch, * a batch are stored with highest durability specified of for all operations in a batch,
* except for {@link Durability#SKIP_WAL}. * except for {@link Durability#SKIP_WAL}.
* *
* <p>This function is called from {@link #batchReplay(MutationReplay[], long)} with * <p>This function is called from {@link #batchReplay(WALSplitUtil.MutationReplay[], long)} with
* {@link ReplayBatchOperation} instance and {@link #batchMutate(Mutation[], long, long)} with * {@link ReplayBatchOperation} instance and {@link #batchMutate(Mutation[], long, long)} with
* {@link MutationBatchOperation} instance as an argument. As the processing of replay batch * {@link MutationBatchOperation} instance as an argument. As the processing of replay batch
* and mutation batch is very similar, lot of code is shared by providing generic methods in * and mutation batch is very similar, lot of code is shared by providing generic methods in
@ -4058,7 +4058,7 @@ public class HRegion implements HeapSize, PropagatingConfigurationObserver, Regi
* @param batchOp contains the list of mutations * @param batchOp contains the list of mutations
* @return an array of OperationStatus which internally contains the * @return an array of OperationStatus which internally contains the
* OperationStatusCode and the exceptionMessage if any. * OperationStatusCode and the exceptionMessage if any.
* @throws IOException * @throws IOException if an IO problem is encountered
*/ */
OperationStatus[] batchMutate(BatchOperation<?> batchOp) throws IOException { OperationStatus[] batchMutate(BatchOperation<?> batchOp) throws IOException {
boolean initialized = false; boolean initialized = false;

View File

@ -453,7 +453,8 @@ public class BulkLoadHFilesTool extends Configured implements BulkLoadHFiles, To
} }
/** /**
* @param table the table to load into * @param conn the HBase cluster connection
* @param tableName the table name of the table to load into
* @param pool the ExecutorService * @param pool the ExecutorService
* @param queue the queue for LoadQueueItem * @param queue the queue for LoadQueueItem
* @param startEndKeys start and end keys * @param startEndKeys start and end keys

View File

@ -2039,16 +2039,16 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility {
} }
/** /**
* @param tableName * @param tableName the name of the table
* @param startKey * @param startKey the start key of the region
* @param stopKey * @param stopKey the stop key of the region
* @param callingMethod * @param callingMethod the name of the calling method probably a test method
* @param conf * @param conf the configuration to use
* @param isReadOnly * @param isReadOnly {@code true} if the table is read only, {@code false} otherwise
* @param families * @param families the column families to use
* @throws IOException * @throws IOException if an IO problem is encountered
* @return A region on which you must call * @return A region on which you must call {@link HBaseTestingUtility#closeRegionAndWAL(HRegion)}
{@link HBaseTestingUtility#closeRegionAndWAL(HRegion)} when done. * when done.
* @deprecated since 2.0.0 and will be removed in 3.0.0. Use * @deprecated since 2.0.0 and will be removed in 3.0.0. Use
* {@link #createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)} * {@link #createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)}
* instead. * instead.
@ -3292,10 +3292,9 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility {
* Waits for a table to be 'enabled'. Enabled means that table is set as 'enabled' and the * Waits for a table to be 'enabled'. Enabled means that table is set as 'enabled' and the
* regions have been all assigned. Will timeout after default period (30 seconds) * regions have been all assigned. Will timeout after default period (30 seconds)
* Tolerates nonexistent table. * Tolerates nonexistent table.
* @param table Table to wait on. * @param table the table to wait on.
* @param table * @throws InterruptedException if interrupted while waiting
* @throws InterruptedException * @throws IOException if an IO problem is encountered
* @throws IOException
*/ */
public void waitTableEnabled(TableName table) public void waitTableEnabled(TableName table)
throws InterruptedException, IOException { throws InterruptedException, IOException {

View File

@ -153,8 +153,8 @@ class MockRegionServer implements AdminProtos.AdminService.BlockingInterface,
private final Random random = new Random(); private final Random random = new Random();
/** /**
* Map of regions to map of rows and {@link Result}. Used as data source when * Map of regions to map of rows and {@link Result}. Used as data source when
* {@link #get(RpcController, GetRequest)} is called. Because we have a byte * {@link #get(RpcController, ClientProtos.GetRequest)} is called. Because we have a byte
* key, need to use TreeMap and provide a Comparator. Use * key, need to use TreeMap and provide a Comparator. Use
* {@link #setGetResult(byte[], byte[], Result)} filling this map. * {@link #setGetResult(byte[], byte[], Result)} filling this map.
*/ */
@ -205,10 +205,11 @@ class MockRegionServer implements AdminProtos.AdminService.BlockingInterface,
} }
/** /**
* Use this method filling the backing data source used by {@link #get(RpcController, GetRequest)} * Use this method filling the backing data source used by
* @param regionName * {@link #get(RpcController, ClientProtos.GetRequest)}
* @param row * @param regionName the region name to assign
* @param r * @param row the row key
* @param r the single row result
*/ */
void setGetResult(final byte [] regionName, final byte [] row, final Result r) { void setGetResult(final byte [] regionName, final byte [] row, final Result r) {
Map<byte [], Result> value = this.gets.get(regionName); Map<byte [], Result> value = this.gets.get(regionName);

View File

@ -284,7 +284,7 @@ public class TestFlushSnapshotFromClient {
* complete on the server by repeatedly checking the master. * complete on the server by repeatedly checking the master.
* @param master the master running the snapshot * @param master the master running the snapshot
* @param snapshot the snapshot to check * @param snapshot the snapshot to check
* @param sleep amount to sleep between checks to see if the snapshot is done * @param timeoutNanos the timeout in nano between checks to see if the snapshot is done
*/ */
private static void waitForSnapshotToComplete(HMaster master, private static void waitForSnapshotToComplete(HMaster master,
SnapshotProtos.SnapshotDescription snapshot, long timeoutNanos) throws Exception { SnapshotProtos.SnapshotDescription snapshot, long timeoutNanos) throws Exception {

View File

@ -3767,6 +3767,15 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API Note:</head>
</tag>
</tags>
</configuration>
<reportSets> <reportSets>
<!-- Dev API --> <!-- Dev API -->
<reportSet> <reportSet>