diff --git a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/PathOutputCommitterFactory.java b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/PathOutputCommitterFactory.java index 0df14d1c02..7d214f281f 100644 --- a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/PathOutputCommitterFactory.java +++ b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/PathOutputCommitterFactory.java @@ -39,12 +39,12 @@ * * Algorithm: *
    - * - * - * + * its factory is instantiated. + *
  1. Otherwise, an instance of {@link FileOutputCommitter} is + * created.
    2. *
* * In {@link FileOutputFormat}, the created factory has its method @@ -186,7 +186,7 @@ public static PathOutputCommitterFactory getCommitterFactory( } /** - * Create the committer factory for a task attempt & destination, then + * Create the committer factory for a task attempt and destination, then * create the committer from it. * @param outputPath the task's output path, or or null if no output path * has been defined. diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Invoker.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Invoker.java index 9900f4c7af..107a247a27 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Invoker.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Invoker.java @@ -55,7 +55,7 @@ * * The static {@link #quietly(String, String, VoidOperation)} and * {@link #quietlyEval(String, String, Operation)} calls exist to take any - * operation and quietly catch & log at debug. The return value of + * operation and quietly catch and log at debug. The return value of * {@link #quietlyEval(String, String, Operation)} is a java 8 optional, * which can then be used in java8-expressions. */ @@ -390,9 +390,11 @@ public static void quietly(String action, * Execute an operation; any exception raised is caught and * logged at debug. * The result is only non-empty if the operation succeeded + * @param type to return * @param action action to execute * @param path path (for exception construction) * @param operation operation + * @return the result of a successful operation */ public static Optional quietlyEval(String action, String path, diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java index b08a134f5d..fba8ea1517 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java @@ -1247,7 +1247,7 @@ private void validateListArguments(S3ListRequest request) { * @param request last list objects request to continue * @param prevResult last paged result to continue from * @return the next result object - * @throws IOException: none, just there for retryUntranslated. + * @throws IOException none, just there for retryUntranslated. */ @Retries.RetryRaw protected S3ListResult continueListObjects(S3ListRequest request, diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java index 70926e6bc6..23ceafa055 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java @@ -949,8 +949,10 @@ public static void applyLocatedFiles( /** * Map an operation to every {@link LocatedFileStatus} in a remote * iterator, returning a list of the results. + * @param return type of map * @param iterator iterator from a list * @param eval closure to evaluate + * @return the list of mapped results. * @throws IOException anything in the closure, or iteration logic. */ public static List mapLocatedFiles( @@ -965,8 +967,10 @@ public static List mapLocatedFiles( /** * Map an operation to every {@link LocatedFileStatus} in a remote * iterator, returning a list of the all results which were not empty. + * @param return type of map * @param iterator iterator from a list * @param eval closure to evaluate + * @return the flattened list of mapped results. * @throws IOException anything in the closure, or iteration logic. */ public static List flatmapLocatedFiles( diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/WriteOperationHelper.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/WriteOperationHelper.java index b3dd4e22a3..477200e810 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/WriteOperationHelper.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/WriteOperationHelper.java @@ -179,6 +179,7 @@ public ObjectMetadata newObjectMetadata(long length) { /** * Start the multipart upload process. * Retry policy: retrying, translated. + * @param destKey destination of upload * @return the upload result containing the ID * @throws IOException IO problem */ diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/AbstractS3ACommitter.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/AbstractS3ACommitter.java index 32779160df..5f1ddfa6fc 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/AbstractS3ACommitter.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/AbstractS3ACommitter.java @@ -523,6 +523,7 @@ protected void abortJobInternal(JobContext context, * Abort all pending uploads to the destination directory during * job cleanup operations. * @param suppressExceptions should exceptions be suppressed + * @throws IOException IO problem */ protected void abortPendingUploadsInCleanup( boolean suppressExceptions) throws IOException { diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/CommitOperations.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/CommitOperations.java index 9381ef1ff3..1338d2e080 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/CommitOperations.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/CommitOperations.java @@ -529,7 +529,7 @@ public void jobCompleted(boolean success) { * {@link #maybeRethrow()} could be done as a map(), but because Java doesn't * allow checked exceptions in a map, the following code is invalid * 
-   *   exception.map((e) -> {throw e;}
+   *   exception.map((e) -> {throw e;}
    *
* As a result, the code to work with exceptions would be almost as convoluted * as the original. diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/staging/StagingCommitter.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/staging/StagingCommitter.java index 922d1addc8..2182eaa2dd 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/staging/StagingCommitter.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/commit/staging/StagingCommitter.java @@ -413,6 +413,7 @@ protected String getFinalKey(String relative, JobContext context) { * @param relative the path of a file relative to the task attempt path * @param context the JobContext or TaskAttemptContext for this job * @return the S3 Path where the file will be uploaded + * @throws IOException IO problem */ protected final Path getFinalPath(String relative, JobContext context) throws IOException { diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DynamoDBMetadataStore.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DynamoDBMetadataStore.java index 13384cfdc2..4dfbdc835f 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DynamoDBMetadataStore.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DynamoDBMetadataStore.java @@ -745,7 +745,7 @@ static FileStatus makeDirStatus(Path f, String owner) { * the call to {@link #processBatchWriteRequest(PrimaryKey[], Item[])} * is only tried once. * @param meta Directory listing metadata. - * @throws IOException + * @throws IOException IO problem */ @Override @Retries.OnceTranslated("retry(listFullPaths); once(batchWrite)")