alluxio.cli.fs.command

Class CpCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.CpCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class CpCommand
extends AbstractFileSystemCommand

Copies a file or a directory in the Alluxio filesystem.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.cli.Option	BUFFER_SIZE_OPTION
static org.apache.commons.cli.Option	THREAD_OPTION

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
CpCommand(FileSystemContext fsContext)

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
org.apache.commons.cli.Options	getOptions()
String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

processHeader, runPlainPath, runWildCardCmd

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getSubCommands, hasSubCommand, parseAndValidateArgs

Field Detail

THREAD_OPTION

public static final org.apache.commons.cli.Option THREAD_OPTION

BUFFER_SIZE_OPTION

public static final org.apache.commons.cli.Option BUFFER_SIZE_OPTION

Constructor Detail

CpCommand

public CpCommand(FileSystemContext fsContext)

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

getOptions

public org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command