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 e6a4cf406c2..f2357730d4c 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 @@ -303,7 +303,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) @@ -2713,7 +2713,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/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/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. - -