Package org.apache.hadoop.fs.shell

Class FsCommand

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.shell.Command

org.apache.hadoop.fs.shell.FsCommand

All Implemented Interfaces:

Configurable

Direct Known Subclasses:

Concat, CopyCommandWithMultiThread, Count, Find, FsShell.Help, FsShell.Usage, FsShellPermissions, TouchCommands, Truncate

@Private
@Evolving
public abstract class FsCommand
extends Command

Base class for all "hadoop fs" commands.

Field Summary

Fields inherited from class org.apache.hadoop.fs.shell.Command

args, COMMAND_DESCRIPTION_FIELD, COMMAND_NAME_FIELD, COMMAND_USAGE_FIELD, err, exceptions, exitCode, name, numErrors, out, recursive

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FsCommand()
protected	FsCommand(Configuration conf)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommandName()
protected void	processRawArguments(java.util.LinkedList<java.lang.String> args)	Allows commands that don't use paths to handle the raw arguments.
static void	registerCommands(CommandFactory factory)	Register the command classes used by the fs subcommand
protected void	run(Path path)	Execute the command on the input path
int	runAll()	Deprecated. use Command.run(String...argv)

Methods inherited from class org.apache.hadoop.fs.shell.Command

displayError, displayError, displayWarning, exitCodeForError, expandArgument, expandArguments, getCommandFactory, getDepth, getDescription, getListingGroupSize, getName, getReplacementCommand, getUsage, isDeprecated, isPathRecursable, isRecursive, isSorted, postProcessPath, processArgument, processArguments, processNonexistentPath, processOptions, processPath, processPathArgument, processPaths, processPaths, recursePath, run, run, setCommandFactory, setName, setRecursive

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FsCommand

protected FsCommand()

FsCommand

protected FsCommand(Configuration conf)

Method Detail

registerCommands

public static void registerCommands(CommandFactory factory)

Register the command classes used by the fs subcommand

Parameters:

factory - where to register the class

getCommandName

public java.lang.String getCommandName()

Specified by:

getCommandName in class Command

Returns:

the command's name excluding the leading character -

run

protected void run(Path path)
            throws java.io.IOException

Description copied from class: Command

Execute the command on the input path

Specified by:

run in class Command

Parameters:

path - the input path

Throws:

java.io.IOException - if any error occurs

runAll

@Deprecated
public int runAll()

Deprecated.

use Command.run(String...argv)

Description copied from class: Command

For each source path, execute the command

Overrides:

runAll in class Command

Returns:

0 if it runs successfully; -1 if it fails

processRawArguments

protected void processRawArguments(java.util.LinkedList<java.lang.String> args)
                            throws java.io.IOException

Description copied from class: Command

Allows commands that don't use paths to handle the raw arguments. Default behavior is to expand the arguments via Command.expandArguments(LinkedList) and pass the resulting list to Command.processArguments(LinkedList)

Overrides:

processRawArguments in class Command

Parameters:

args - the list of argument strings

Throws:

java.io.IOException - raised on errors performing I/O.