Package org.apache.accumulo.shell.commands

Class HelpCommand

java.lang.Object

org.apache.accumulo.shell.Shell.Command

org.apache.accumulo.shell.commands.HelpCommand

Direct Known Subclasses:

QuestionCommand

public class HelpCommand
extends Shell.Command

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.accumulo.shell.Shell.Command

Shell.Command.CompletionSet

Constructor Summary

Constructors

Constructor	Description
HelpCommand()

Method Summary

Modifier and Type	Method	Description
String	description()
int	execute(String fullCommand, org.apache.commons.cli.CommandLine cl, Shell shellState)
org.apache.commons.cli.Options	getOptions()
int	numArgs()	If the number of arguments is not always zero (not including those arguments handled through Options), make sure to override the Shell.Command.usage() method.
void	registerCompletion(Token root, Map<Shell.Command.CompletionSet,Set<String>> special)
String	usage()

Methods inherited from class org.apache.accumulo.shell.Shell.Command

getName, getOptionsWithHelp, printHelp, printHelp, registerCompletionForCommands, registerCompletionForNamespaces, registerCompletionForTables, registerCompletionForUsers, registerCompletionGeneral

Methods inherited from class java.lang.Object

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

Constructor Details

HelpCommand

public HelpCommand()

Method Details

execute

public int execute(String fullCommand,
 org.apache.commons.cli.CommandLine cl,
 Shell shellState)
            throws ShellCommandException,
IOException

Specified by:

execute in class Shell.Command

Throws:

ShellCommandException

IOException

description

public String description()

Specified by:

description in class Shell.Command

registerCompletion

public void registerCompletion(Token root,
 Map<Shell.Command.CompletionSet,Set<String>> special)

Overrides:

registerCompletion in class Shell.Command

getOptions

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

Overrides:

getOptions in class Shell.Command

usage

public String usage()

Overrides:

usage in class Shell.Command

numArgs

public int numArgs()

Description copied from class: Shell.Command

If the number of arguments is not always zero (not including those arguments handled through Options), make sure to override the Shell.Command.usage() method. Otherwise, Shell.Command.usage() does need to be overridden.

Specified by:

numArgs in class Shell.Command