HDDS-842. [JDK11] Fix Javadoc errors in hadoop-hdds-common module. Contributed by Dinesh Chitlangia.
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/fcd94eea Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/fcd94eea Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/fcd94eea Branch: refs/heads/HDFS-12943 Commit: fcd94eeab8a7f890163fb824b396ab07ed94aa70 Parents: d8ec017 Author: Giovanni Matteo Fumarola <gif...@apache.org> Authored: Thu Nov 15 14:59:31 2018 -0800 Committer: Giovanni Matteo Fumarola <gif...@apache.org> Committed: Thu Nov 15 14:59:31 2018 -0800 ---------------------------------------------------------------------- .../java/org/apache/hadoop/hdds/scm/client/ScmClient.java | 2 +- .../apache/hadoop/hdds/scm/protocol/LocatedContainer.java | 2 +- .../org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java | 2 +- .../hdds/scm/protocol/StorageContainerLocationProtocol.java | 2 +- .../hadoop/hdds/scm/storage/ContainerProtocolCalls.java | 8 +++++--- .../main/java/org/apache/hadoop/ozone/audit/Auditable.java | 2 +- 6 files changed, 10 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/client/ScmClient.java ---------------------------------------------------------------------- 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 0af3b16..6250adf 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 http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/LocatedContainer.java ---------------------------------------------------------------------- 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 14ee3d2..10a9b1b 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<DatanodeInfo> nodes that currently host the container + * @return {@code Set<DatanodeInfo>} nodes that currently host the container */ public Set<DatanodeInfo> getLocations() { return this.locations; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/ScmLocatedBlock.java ---------------------------------------------------------------------- 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 6cbdee4..0d2ecf7 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<DatanodeInfo> nodes that currently host the block + * @return {@literal List<DatanodeInfo>} nodes that currently host the block */ public List<DatanodeInfo> getLocations() { return this.locations; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/protocol/StorageContainerLocationProtocol.java ---------------------------------------------------------------------- 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 82dfe16..14c55c3 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) * http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/storage/ContainerProtocolCalls.java ---------------------------------------------------------------------- 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 04f4cbc..1f20d00 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 http://git-wip-us.apache.org/repos/asf/hadoop/blob/fcd94eea/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/audit/Auditable.java ---------------------------------------------------------------------- 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 d388bca..9d7dbee 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<String, String> with values to be logged in audit. + * @return {@literal Map<String, String>} with values to be logged in audit. */ Map<String, String> toAuditMap(); } --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org
