MAPREDUCE-7149. Javadocs for FileInputFormat and OutputFormat to mention DT collection.
Contributed by Steve Loughran.
This commit is contained in:
parent
96d28b4750
commit
735a36afd5
|
@ -198,11 +198,15 @@ public abstract class FileInputFormat<K, V> implements InputFormat<K, V> {
|
|||
}
|
||||
}
|
||||
|
||||
/** List input directories.
|
||||
/**
|
||||
* List input directories.
|
||||
* Subclasses may override to, e.g., select only files matching a regular
|
||||
* 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
|
||||
* @throws IOException if zero items.
|
||||
*/
|
||||
|
|
|
@ -71,6 +71,9 @@ public interface OutputFormat<K, V> {
|
|||
* throwing an exception when it already exists, so that output is not
|
||||
* 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 job job configuration.
|
||||
* @throws IOException when output should not be attempted
|
||||
|
|
|
@ -66,6 +66,9 @@ public abstract class OutputFormat<K, V> {
|
|||
* throwing an exception when it already exists, so that output is not
|
||||
* 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
|
||||
* @throws IOException when output should not be attempted
|
||||
*/
|
||||
|
|
|
@ -233,11 +233,15 @@ public abstract class FileInputFormat<K, V> extends InputFormat<K, V> {
|
|||
(PathFilter) ReflectionUtils.newInstance(filterClass, conf) : null;
|
||||
}
|
||||
|
||||
/** List input directories.
|
||||
/**
|
||||
* List input directories.
|
||||
* Subclasses may override to, e.g., select only files matching a regular
|
||||
* 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
|
||||
* @throws IOException if zero items.
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue