Package alluxio.cli.fs.command

Class HelpCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.HelpCommand

All Implemented Interfaces:

alluxio.cli.Command, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
@PublicApi
public final class HelpCommand
extends AbstractFileSystemCommand

Command for print help message for the given command. If there isn't given command, print help messages for all supported commands.

Field Summary

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

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor	Description
HelpCommand(alluxio.client.file.FileSystemContext fsContext)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommandName()
java.lang.String	getDescription()
java.lang.String	getUsage()
static void	printCommandInfo(alluxio.cli.Command command, java.io.PrintWriter pw)	Prints the info about a command to the given print writer.
int	run(org.apache.commons.cli.CommandLine cl)
void	validateArgs(org.apache.commons.cli.CommandLine cl)

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, getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

HelpCommand

public HelpCommand(alluxio.client.file.FileSystemContext fsContext)

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

printCommandInfo

public static void printCommandInfo(alluxio.cli.Command command,
                                    java.io.PrintWriter pw)

Prints the info about a command to the given print writer.

Parameters:

command - command to print info

pw - where to print the info

getCommandName

public java.lang.String getCommandName()

run

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

Throws:

alluxio.exception.AlluxioException

java.io.IOException

getUsage

public java.lang.String getUsage()

getDescription

public java.lang.String getDescription()

validateArgs

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

Throws:

alluxio.exception.status.InvalidArgumentException