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

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hbase-client/src/main/java/org/apache/hadoop/hbase/client/BufferedMutatorParams.java
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
public BufferedMutatorParams opertationTimeout(final int operationTimeout) {

7
hbase-client/src/main/java/org/apache/hadoop/hbase/client/SimpleRequestController.java
View File

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

10
hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java
View File

@ -176,8 +176,8 @@ public interface Table extends Closeable {
* @throws IOException if a remote or network exception occurs.
* @since 0.90.0
* @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
* is no need, but this may change in the future. An
* Currently {@link #get(List)} doesn't run any validations on the client-side,
* currently there is no need, but this may change in the future. An
* {@link IllegalArgumentException} will be thrown in this case.
*/
default Result[] get(List<Get> gets) throws IOException {
@ -285,9 +285,9 @@ public interface Table extends Closeable {
* @since 0.20.1
* @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 #delete(List)} doesn't run validations on the client, there is no need currently,
* but this may change in the future. An * {@link IllegalArgumentException} will be thrown
* in this case.
* {@link #delete(List)} doesn't run validations on the client, there is no need
* currently, but this may change in the future. An * {@link IllegalArgumentException}
* will be thrown in this case.
*/
default void delete(List<Delete> deletes) throws IOException {
throw new NotImplementedException("Add an implementation!");

2
hbase-client/src/main/java/org/apache/hadoop/hbase/client/coprocessor/Batch.java
View File

@ -39,7 +39,7 @@ public abstract class Batch {
* 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.
* </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(Class, byte[], byte[],
* org.apache.hadoop.hbase.client.coprocessor.Batch.Call)

3
hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/snapshot/ExportSnapshot.java
View File

@ -267,9 +267,10 @@ public class ExportSnapshot extends AbstractHBaseTool implements Tool {
return new Path(outputArchive, path);
}
@SuppressWarnings("checkstyle:linelength")
/**
* 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)
throws IOException {

10
hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.java
View File

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

2
hbase-server/src/main/java/org/apache/hadoop/hbase/master/assignment/RegionStateNode.java
View File

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

4
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java
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,
* 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 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
@ -4058,7 +4058,7 @@ public class HRegion implements HeapSize, PropagatingConfigurationObserver, Regi
* @param batchOp contains the list of mutations
* @return an array of OperationStatus which internally contains the
* OperationStatusCode and the exceptionMessage if any.
* @throws IOException
* @throws IOException if an IO problem is encountered
*/
OperationStatus[] batchMutate(BatchOperation<?> batchOp) throws IOException {
boolean initialized = false;

3
hbase-server/src/main/java/org/apache/hadoop/hbase/tool/BulkLoadHFilesTool.java
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 queue the queue for LoadQueueItem
* @param startEndKeys start and end keys

27
hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java
View File

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

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

@ -154,7 +154,7 @@ class MockRegionServer implements AdminProtos.AdminService.BlockingInterface,
/**
* 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
* {@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)}
* @param regionName
* @param row
* @param r
* Use this method filling the backing data source used by
* {@link #get(RpcController, ClientProtos.GetRequest)}
* @param regionName the region name to assign
* @param row the row key
* @param r the single row result
*/
void setGetResult(final byte [] regionName, final byte [] row, final Result r) {
Map<byte [], Result> value = this.gets.get(regionName);

2
hbase-server/src/test/java/org/apache/hadoop/hbase/snapshot/TestFlushSnapshotFromClient.java
View File

@ -284,7 +284,7 @@ public class TestFlushSnapshotFromClient {
* complete on the server by repeatedly checking the master.
* @param master the master running the snapshot
* @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,
SnapshotProtos.SnapshotDescription snapshot, long timeoutNanos) throws Exception {

9
pom.xml
View File

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