MAPREDUCE-7149. Javadocs for FileInputFormat and OutputFormat to mention DT collection.

Contributed by Steve Loughran.
This commit is contained in:
Steve Loughran 2018-10-11 20:01:42 +01:00
parent 96d28b4750
commit 735a36afd5
No known key found for this signature in database
GPG Key ID: D22CF846DBB162A0
4 changed files with 19 additions and 5 deletions

View File

@ -198,11 +198,15 @@ protected void addInputPathRecursively(List<FileStatus> result,
} }
} }
/** List input directories. /**
* List input directories.
* Subclasses may override to, e.g., select only files matching a regular * Subclasses may override to, e.g., select only files matching a regular
* expression. * expression.
* *
* @param job the job to list input paths for * If security is enabled, this method collects
* delegation tokens from the input paths and adds them to the job's
* credentials.
* @param job the job to list input paths for and attach tokens to.
* @return array of FileStatus objects * @return array of FileStatus objects
* @throws IOException if zero items. * @throws IOException if zero items.
*/ */

View File

@ -71,6 +71,9 @@ RecordWriter<K, V> getRecordWriter(FileSystem ignored, JobConf job,
* throwing an exception when it already exists, so that output is not * throwing an exception when it already exists, so that output is not
* overwritten.</p> * overwritten.</p>
* *
* Implementations which write to filesystems which support delegation
* tokens usually collect the tokens for the destination path(s)
* and attach them to the job configuration.
* @param ignored * @param ignored
* @param job job configuration. * @param job job configuration.
* @throws IOException when output should not be attempted * @throws IOException when output should not be attempted

View File

@ -66,6 +66,9 @@ public abstract class OutputFormat<K, V> {
* throwing an exception when it already exists, so that output is not * throwing an exception when it already exists, so that output is not
* overwritten.</p> * overwritten.</p>
* *
* Implementations which write to filesystems which support delegation
* tokens usually collect the tokens for the destination path(s)
* and attach them to the job context's JobConf.
* @param context information about the job * @param context information about the job
* @throws IOException when output should not be attempted * @throws IOException when output should not be attempted
*/ */

View File

@ -233,11 +233,15 @@ public static PathFilter getInputPathFilter(JobContext context) {
(PathFilter) ReflectionUtils.newInstance(filterClass, conf) : null; (PathFilter) ReflectionUtils.newInstance(filterClass, conf) : null;
} }
/** List input directories. /**
* List input directories.
* Subclasses may override to, e.g., select only files matching a regular * Subclasses may override to, e.g., select only files matching a regular
* expression. * expression.
* *
* @param job the job to list input paths for * If security is enabled, this method collects
* delegation tokens from the input paths and adds them to the job's
* credentials.
* @param job the job to list input paths for and attach tokens to.
* @return array of FileStatus objects * @return array of FileStatus objects
* @throws IOException if zero items. * @throws IOException if zero items.
*/ */