alluxio.cli.extensions.command

Class LsCommand

java.lang.Object

alluxio.cli.extensions.command.LsCommand

All Implemented Interfaces:

Command

@ThreadSafe
public final class LsCommand
extends Object
implements Command

Lists all installed extensions.

Constructor Summary

Constructors

Constructor and Description
LsCommand() Constructs a new instance of LsCommand.

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
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 java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

LsCommand

public LsCommand()

Constructs a new instance of LsCommand.

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Specified by:

getCommandName in interface Command

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.

Specified by:

validateArgs in interface Command

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

getUsage

public String getUsage()

Specified by:

getUsage in interface Command

Returns:

the usage information of the command

getDescription

public String getDescription()

Specified by:

getDescription in interface Command

Returns:

the description information of the command

run

public int run(org.apache.commons.cli.CommandLine cl)

Description copied from interface: Command

Runs the command.

Specified by:

run in interface Command

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command