MAPREDUCE-7014. Fix java doc errors in jdk1.8. Contributed by Steve Loughran.
This commit is contained in:
parent
2bde3aedf1
commit
3cd75845da
@ -39,12 +39,12 @@
|
|||||||
*
|
*
|
||||||
* Algorithm:
|
* Algorithm:
|
||||||
* <ol>
|
* <ol>
|
||||||
* <ul>If an explicit committer factory is named, it is used.</ul>
|
* <li>If an explicit committer factory is named, it is used.</li>
|
||||||
* <ul>The output path is examined.
|
* <li>The output path is examined.
|
||||||
* If is non null and there is an explicit schema for that filesystem,
|
* If is non null and there is an explicit schema for that filesystem,
|
||||||
* its factory is instantiated.</ul>
|
* its factory is instantiated.</li>
|
||||||
* <ul>Otherwise, an instance of {@link FileOutputCommitter} is
|
* <li>Otherwise, an instance of {@link FileOutputCommitter} is
|
||||||
* created.</ul>
|
* created.</li>
|
||||||
* </ol>
|
* </ol>
|
||||||
*
|
*
|
||||||
* In {@link FileOutputFormat}, the created factory has its method
|
* 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.
|
* create the committer from it.
|
||||||
* @param outputPath the task's output path, or or null if no output path
|
* @param outputPath the task's output path, or or null if no output path
|
||||||
* has been defined.
|
* has been defined.
|
||||||
|
@ -55,7 +55,7 @@
|
|||||||
*
|
*
|
||||||
* The static {@link #quietly(String, String, VoidOperation)} and
|
* The static {@link #quietly(String, String, VoidOperation)} and
|
||||||
* {@link #quietlyEval(String, String, Operation)} calls exist to take any
|
* {@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,
|
* {@link #quietlyEval(String, String, Operation)} is a java 8 optional,
|
||||||
* which can then be used in java8-expressions.
|
* 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
|
* Execute an operation; any exception raised is caught and
|
||||||
* logged at debug.
|
* logged at debug.
|
||||||
* The result is only non-empty if the operation succeeded
|
* The result is only non-empty if the operation succeeded
|
||||||
|
* @param <T> type to return
|
||||||
* @param action action to execute
|
* @param action action to execute
|
||||||
* @param path path (for exception construction)
|
* @param path path (for exception construction)
|
||||||
* @param operation operation
|
* @param operation operation
|
||||||
|
* @return the result of a successful operation
|
||||||
*/
|
*/
|
||||||
public static <T> Optional<T> quietlyEval(String action,
|
public static <T> Optional<T> quietlyEval(String action,
|
||||||
String path,
|
String path,
|
||||||
|
@ -1247,7 +1247,7 @@ private void validateListArguments(S3ListRequest request) {
|
|||||||
* @param request last list objects request to continue
|
* @param request last list objects request to continue
|
||||||
* @param prevResult last paged result to continue from
|
* @param prevResult last paged result to continue from
|
||||||
* @return the next result object
|
* @return the next result object
|
||||||
* @throws IOException: none, just there for retryUntranslated.
|
* @throws IOException none, just there for retryUntranslated.
|
||||||
*/
|
*/
|
||||||
@Retries.RetryRaw
|
@Retries.RetryRaw
|
||||||
protected S3ListResult continueListObjects(S3ListRequest request,
|
protected S3ListResult continueListObjects(S3ListRequest request,
|
||||||
|
@ -949,8 +949,10 @@ public static void applyLocatedFiles(
|
|||||||
/**
|
/**
|
||||||
* Map an operation to every {@link LocatedFileStatus} in a remote
|
* Map an operation to every {@link LocatedFileStatus} in a remote
|
||||||
* iterator, returning a list of the results.
|
* iterator, returning a list of the results.
|
||||||
|
* @param <T> return type of map
|
||||||
* @param iterator iterator from a list
|
* @param iterator iterator from a list
|
||||||
* @param eval closure to evaluate
|
* @param eval closure to evaluate
|
||||||
|
* @return the list of mapped results.
|
||||||
* @throws IOException anything in the closure, or iteration logic.
|
* @throws IOException anything in the closure, or iteration logic.
|
||||||
*/
|
*/
|
||||||
public static <T> List<T> mapLocatedFiles(
|
public static <T> List<T> mapLocatedFiles(
|
||||||
@ -965,8 +967,10 @@ public static <T> List<T> mapLocatedFiles(
|
|||||||
/**
|
/**
|
||||||
* Map an operation to every {@link LocatedFileStatus} in a remote
|
* Map an operation to every {@link LocatedFileStatus} in a remote
|
||||||
* iterator, returning a list of the all results which were not empty.
|
* iterator, returning a list of the all results which were not empty.
|
||||||
|
* @param <T> return type of map
|
||||||
* @param iterator iterator from a list
|
* @param iterator iterator from a list
|
||||||
* @param eval closure to evaluate
|
* @param eval closure to evaluate
|
||||||
|
* @return the flattened list of mapped results.
|
||||||
* @throws IOException anything in the closure, or iteration logic.
|
* @throws IOException anything in the closure, or iteration logic.
|
||||||
*/
|
*/
|
||||||
public static <T> List<T> flatmapLocatedFiles(
|
public static <T> List<T> flatmapLocatedFiles(
|
||||||
|
@ -179,6 +179,7 @@ public ObjectMetadata newObjectMetadata(long length) {
|
|||||||
/**
|
/**
|
||||||
* Start the multipart upload process.
|
* Start the multipart upload process.
|
||||||
* Retry policy: retrying, translated.
|
* Retry policy: retrying, translated.
|
||||||
|
* @param destKey destination of upload
|
||||||
* @return the upload result containing the ID
|
* @return the upload result containing the ID
|
||||||
* @throws IOException IO problem
|
* @throws IOException IO problem
|
||||||
*/
|
*/
|
||||||
|
@ -523,6 +523,7 @@ protected void abortJobInternal(JobContext context,
|
|||||||
* Abort all pending uploads to the destination directory during
|
* Abort all pending uploads to the destination directory during
|
||||||
* job cleanup operations.
|
* job cleanup operations.
|
||||||
* @param suppressExceptions should exceptions be suppressed
|
* @param suppressExceptions should exceptions be suppressed
|
||||||
|
* @throws IOException IO problem
|
||||||
*/
|
*/
|
||||||
protected void abortPendingUploadsInCleanup(
|
protected void abortPendingUploadsInCleanup(
|
||||||
boolean suppressExceptions) throws IOException {
|
boolean suppressExceptions) throws IOException {
|
||||||
|
@ -529,7 +529,7 @@ public void jobCompleted(boolean success) {
|
|||||||
* {@link #maybeRethrow()} could be done as a map(), but because Java doesn't
|
* {@link #maybeRethrow()} could be done as a map(), but because Java doesn't
|
||||||
* allow checked exceptions in a map, the following code is invalid
|
* allow checked exceptions in a map, the following code is invalid
|
||||||
* <pre>
|
* <pre>
|
||||||
* exception.map((e) -> {throw e;}
|
* exception.map((e) -> {throw e;}
|
||||||
* </pre>
|
* </pre>
|
||||||
* As a result, the code to work with exceptions would be almost as convoluted
|
* As a result, the code to work with exceptions would be almost as convoluted
|
||||||
* as the original.
|
* as the original.
|
||||||
|
@ -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 relative the path of a file relative to the task attempt path
|
||||||
* @param context the JobContext or TaskAttemptContext for this job
|
* @param context the JobContext or TaskAttemptContext for this job
|
||||||
* @return the S3 Path where the file will be uploaded
|
* @return the S3 Path where the file will be uploaded
|
||||||
|
* @throws IOException IO problem
|
||||||
*/
|
*/
|
||||||
protected final Path getFinalPath(String relative, JobContext context)
|
protected final Path getFinalPath(String relative, JobContext context)
|
||||||
throws IOException {
|
throws IOException {
|
||||||
|
@ -745,7 +745,7 @@ static FileStatus makeDirStatus(Path f, String owner) {
|
|||||||
* the call to {@link #processBatchWriteRequest(PrimaryKey[], Item[])}
|
* the call to {@link #processBatchWriteRequest(PrimaryKey[], Item[])}
|
||||||
* is only tried once.
|
* is only tried once.
|
||||||
* @param meta Directory listing metadata.
|
* @param meta Directory listing metadata.
|
||||||
* @throws IOException
|
* @throws IOException IO problem
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
@Retries.OnceTranslated("retry(listFullPaths); once(batchWrite)")
|
@Retries.OnceTranslated("retry(listFullPaths); once(batchWrite)")
|
||||||
|
Loading…
Reference in New Issue
Block a user