From fcd94eeab8a7f890163fb824b396ab07ed94aa70 Mon Sep 17 00:00:00 2001 From: Giovanni Matteo Fumarola Date: Thu, 15 Nov 2018 14:59:31 -0800 Subject: [PATCH] HDDS-842. [JDK11] Fix Javadoc errors in hadoop-hdds-common module. Contributed by Dinesh Chitlangia. --- .../java/org/apache/hadoop/hdds/scm/client/ScmClient.java | 2 +- .../apache/hadoop/hdds/scm/protocol/LocatedContainer.java | 2 +- .../apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java | 2 +- .../scm/protocol/StorageContainerLocationProtocol.java | 2 +- .../hadoop/hdds/scm/storage/ContainerProtocolCalls.java | 8 +++++--- .../java/org/apache/hadoop/ozone/audit/Auditable.java | 2 +- 6 files changed, 10 insertions(+), 8 deletions(-) diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/client/ScmClient.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/client/ScmClient.java index 0af3b16a53d..6250adf421e 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/client/ScmClient.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/client/ScmClient.java @@ -104,7 +104,7 @@ public interface ScmClient extends Closeable { * Lists a range of containers and get their info. * * @param startContainerID start containerID. - * @param count count must be > 0. + * @param count count must be {@literal >} 0. * * @return a list of pipeline. * @throws IOException diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/LocatedContainer.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/LocatedContainer.java index 14ee3d2f80b..10a9b1b5de3 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/LocatedContainer.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/LocatedContainer.java @@ -82,7 +82,7 @@ public final class LocatedContainer { /** * Returns the nodes that currently host the container. * - * @return Set nodes that currently host the container + * @return {@code Set} nodes that currently host the container */ public Set getLocations() { return this.locations; diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java index 6cbdee42387..0d2ecf7ac16 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java @@ -68,7 +68,7 @@ public final class ScmLocatedBlock { /** * Returns the nodes that currently host the block. * - * @return List nodes that currently host the block + * @return {@literal List} nodes that currently host the block */ public List getLocations() { return this.locations; diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/StorageContainerLocationProtocol.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/StorageContainerLocationProtocol.java index 82dfe16c2ec..14c55c31b8c 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/StorageContainerLocationProtocol.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/StorageContainerLocationProtocol.java @@ -73,7 +73,7 @@ public interface StorageContainerLocationProtocol { * searching range cannot exceed the value of count. * * @param startContainerID start container ID. - * @param count count, if count < 0, the max size is unlimited.( + * @param count count, if count {@literal <} 0, the max size is unlimited.( * Usually the count will be replace with a very big * value instead of being unlimited in case the db is very big) * diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/storage/ContainerProtocolCalls.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/storage/ContainerProtocolCalls.java index 04f4cbc8d03..1f20d0098c8 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/storage/ContainerProtocolCalls.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/storage/ContainerProtocolCalls.java @@ -171,7 +171,9 @@ public final class ContainerProtocolCalls { * @param containerBlockData block data to identify container * @param traceID container protocol call args * @return putBlockResponse - * @throws Exception if there is an error while performing the call + * @throws IOException if there is an error while performing the call + * @throws InterruptedException + * @throws ExecutionException */ public static XceiverClientAsyncReply putBlockAsync( XceiverClientSpi xceiverClient, BlockData containerBlockData, @@ -227,7 +229,7 @@ public final class ContainerProtocolCalls { * @param blockID ID of the block * @param data the data of the chunk to write * @param traceID container protocol call args - * @throws Exception if there is an error while performing the call + * @throws IOException if there is an error while performing the call */ public static void writeChunk(XceiverClientSpi xceiverClient, ChunkInfo chunk, BlockID blockID, ByteString data, String traceID) @@ -471,7 +473,7 @@ public final class ContainerProtocolCalls { * return code is mapped to a corresponding exception and thrown. * * @param response container protocol call response - * @throws IOException if the container protocol call failed + * @throws StorageContainerException if the container protocol call failed */ public static void validateContainerResponse( ContainerCommandResponseProto response diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/audit/Auditable.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/audit/Auditable.java index d388bca72f1..9d7dbee35b0 100644 --- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/audit/Auditable.java +++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/audit/Auditable.java @@ -25,7 +25,7 @@ import java.util.Map; public interface Auditable { /** * Must override in implementation. - * @return Map with values to be logged in audit. + * @return {@literal Map} with values to be logged in audit. */ Map toAuditMap(); }