From 74782e7e428f7de759e1cd1b8b574ef44a19af68 Mon Sep 17 00:00:00 2001 From: Masatake Iwasaki Date: Sun, 16 Oct 2016 12:44:19 +0900 Subject: [PATCH] HADOOP-13419. Fix javadoc warnings by JDK8 in hadoop-common package. Contributed by Kai Sasaki. (cherry picked from commit a13a607e2099153a6b63afe06be24c1bc453158f) --- .../org/apache/hadoop/fs/FileContext.java | 4 +- .../org/apache/hadoop/ha/FenceMethod.java | 2 +- .../apache/hadoop/ha/HAServiceProtocol.java | 5 +- .../apache/hadoop/io/retry/package-info.java | 22 +++++++++ .../org/apache/hadoop/io/retry/package.html | 48 ------------------- .../java/org/apache/hadoop/ipc/Server.java | 22 ++++----- .../org/apache/hadoop/ipc/package-info.java | 4 ++ .../java/org/apache/hadoop/ipc/package.html | 23 --------- 8 files changed, 43 insertions(+), 87 deletions(-) delete mode 100644 hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package.html delete mode 100644 hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package.html diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java index 568bf04ce16..b2f0f472f51 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java @@ -315,7 +315,7 @@ public class FileContext { * * @throws UnsupportedFileSystemException If the file system for * absOrFqPath is not supported. - * @throws IOExcepton If the file system for absOrFqPath could + * @throws IOException If the file system for absOrFqPath could * not be instantiated. */ protected AbstractFileSystem getFSofPath(final Path absOrFqPath) @@ -2725,7 +2725,7 @@ public class FileContext { /** * Query the effective storage policy ID for the given file or directory. * - * @param src file or directory path. + * @param path file or directory path. * @return storage policy for give file. * @throws IOException */ diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/FenceMethod.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/FenceMethod.java index ac343fe3478..33e044f661b 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/FenceMethod.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/FenceMethod.java @@ -52,7 +52,7 @@ public interface FenceMethod { /** * Attempt to fence the target node. - * @param serviceAddr the address (host:ipcport) of the service to fence + * @param target the address (host:ipcport) of the service to fence * @param args the configured arguments, which were checked at startup by * {@link #checkArgs(String)} * @return true if fencing was successful, false if unsuccessful or diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/HAServiceProtocol.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/HAServiceProtocol.java index f383d4ce3b4..83239d0cc01 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/HAServiceProtocol.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ha/HAServiceProtocol.java @@ -151,12 +151,13 @@ public interface HAServiceProtocol { /** * Return the current status of the service. The status indicates * the current state (e.g ACTIVE/STANDBY) as well as - * some additional information. {@see HAServiceStatus} - * + * some additional information. + * * @throws AccessControlException * if access is denied. * @throws IOException * if other errors happen + * @see HAServiceStatus */ @Idempotent public HAServiceStatus getServiceStatus() throws AccessControlException, diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package-info.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package-info.java index 693065f35b2..089cf6f54c7 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package-info.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package-info.java @@ -15,6 +15,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A mechanism for selectively retrying methods that throw exceptions under + * certain circumstances. + * Typical usage is + * UnreliableImplementation unreliableImpl = new UnreliableImplementation(); + * UnreliableInterface unreliable = (UnreliableInterface) + * RetryProxy.create(UnreliableInterface.class, unreliableImpl, + * RetryPolicies.retryUpToMaximumCountWithFixedSleep(4, 10, + * TimeUnit.SECONDS)); + * unreliable.call(); + * + * This will retry any method called on unreliable four times - + * in this case the call() method - sleeping 10 seconds between + * each retry. There are a number of + * {@link org.apache.hadoop.io.retry.RetryPolicies retry policies} + * available, or you can implement a custom one by implementing + * {@link org.apache.hadoop.io.retry.RetryPolicy}. + * It is also possible to specify retry policies on a + * {@link org.apache.hadoop.io.retry.RetryProxy#create(Class, Object, Map) + * per-method basis}. + */ @InterfaceAudience.LimitedPrivate({"HBase", "HDFS", "MapReduce"}) @InterfaceStability.Evolving package org.apache.hadoop.io.retry; diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package.html b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package.html deleted file mode 100644 index ae553fc7a62..00000000000 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/retry/package.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - -

-A mechanism for selectively retrying methods that throw exceptions under certain circumstances. -

- -

-Typical usage is -

- -
-UnreliableImplementation unreliableImpl = new UnreliableImplementation();
-UnreliableInterface unreliable = (UnreliableInterface)
-  RetryProxy.create(UnreliableInterface.class, unreliableImpl,
-    RetryPolicies.retryUpToMaximumCountWithFixedSleep(4, 10, TimeUnit.SECONDS));
-unreliable.call();
-
- -

-This will retry any method called on unreliable four times - in this case the call() -method - sleeping 10 seconds between -each retry. There are a number of {@link org.apache.hadoop.io.retry.RetryPolicies retry policies} -available, or you can implement a custom one by implementing {@link org.apache.hadoop.io.retry.RetryPolicy}. -It is also possible to specify retry policies on a -{@link org.apache.hadoop.io.retry.RetryProxy#create(Class, Object, Map) per-method basis}. -

- - - diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/Server.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/Server.java index 5d838dca78d..bf4ca5ccfb3 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/Server.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/Server.java @@ -2035,7 +2035,7 @@ public abstract class Server { } /** Reads the connection context following the connection header - * @param dis - DataInputStream from which to read the header + * @param buffer - DataInputStream from which to read the header * @throws WrappedRpcServerException - if the header cannot be * deserialized, or the user is not authorized */ @@ -2087,7 +2087,7 @@ public abstract class Server { /** * Process a wrapped RPC Request - unwrap the SASL packet and process * each embedded RPC request - * @param buf - SASL wrapped request of one or more RPCs + * @param inBuf - SASL wrapped request of one or more RPCs * @throws IOException - SASL packet cannot be unwrapped * @throws InterruptedException */ @@ -2131,7 +2131,7 @@ public abstract class Server { /** * Process an RPC Request - handle connection setup and decoding of * request into a Call - * @param buf - contains the RPC request header and the rpc request + * @param bb - contains the RPC request header and the rpc request * @throws IOException - internal error that should not be returned to * client, typically failure to respond to client * @throws WrappedRpcServerException - an exception to be sent back to @@ -2207,7 +2207,7 @@ public abstract class Server { * Process an RPC Request - the connection headers and context must * have been already read * @param header - RPC request header - * @param dis - stream to request payload + * @param buffer - stream to request payload * @throws WrappedRpcServerException - due to fatal rpc layer issues such * as invalid header or deserialization error. In this case a RPC fatal * status response will later be sent back to client. @@ -2283,7 +2283,7 @@ public abstract class Server { * Establish RPC connection setup by negotiating SASL if required, then * reading and authorizing the connection header * @param header - RPC header - * @param dis - stream to request payload + * @param buffer - stream to request payload * @throws WrappedRpcServerException - setup failed due to SASL * negotiation failure, premature or invalid connection context, * or other state errors @@ -2351,8 +2351,8 @@ public abstract class Server { /** * Decode the a protobuf from the given input stream - * @param builder - Builder of the protobuf to decode - * @param dis - DataInputStream to read the protobuf + * @param message - Representation of the type of message + * @param buffer - a buffer to read the protobuf * @return Message - decoded protobuf * @throws WrappedRpcServerException - deserialization failed */ @@ -2522,8 +2522,8 @@ public abstract class Server { * from configuration. Otherwise the configuration will be picked up. * * If rpcRequestClass is null then the rpcRequestClass must have been - * registered via {@link #registerProtocolEngine(RpcPayloadHeader.RpcKind, - * Class, RPC.RpcInvoker)} + * registered via {@link #registerProtocolEngine(RPC.RpcKind, Class, + * RPC.RpcInvoker)}. * This parameter has been retained for compatibility with existing tests * and usage. */ @@ -2881,8 +2881,8 @@ public abstract class Server { /** * Called for each call. - * @deprecated Use {@link #call(RpcPayloadHeader.RpcKind, String, - * Writable, long)} instead + * @deprecated Use {@link Server#call(RPC.RpcKind, String, Writable, long)} + * instead. */ @Deprecated public Writable call(Writable param, long receiveTime) throws Exception { diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package-info.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package-info.java index 525ef1f1b67..cb35e938483 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package-info.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package-info.java @@ -15,6 +15,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Tools to help define network clients and servers. + */ @InterfaceAudience.LimitedPrivate({"HBase", "HDFS", "MapReduce"}) @InterfaceStability.Evolving package org.apache.hadoop.ipc; diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package.html b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package.html deleted file mode 100644 index 3efd81a2978..00000000000 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/ipc/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -Tools to help define network clients and servers. - -