org.apache.accumulo.core.util.shell
Class Shell.HelpCommand

java.lang.Object
  org.apache.accumulo.core.util.shell.Shell.Command
      org.apache.accumulo.core.util.shell.Shell.HelpCommand

Direct Known Subclasses:

Shell.QuestionCommand

Enclosing class:

Shell

public static class Shell.HelpCommand
extends Shell.Command

Nested Class Summary

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

Shell.Command.CompletionSet

Constructor Summary

Shell.HelpCommand()

Method Summary

java.lang.String	description()
int	execute(java.lang.String fullCommand, org.apache.commons.cli.CommandLine cl, Shell shellState)
org.apache.commons.cli.Options	getOptions()
int	numArgs()
void	registerCompletion(Token root, java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> special)
java.lang.String	usage()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Shell.HelpCommand

public Shell.HelpCommand()

Method Detail

execute

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

Specified by:

execute in class Shell.Command

Throws:

ShellCommandException

java.io.IOException

description

public java.lang.String description()

Specified by:

description in class Shell.Command

registerCompletion

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

Overrides:

registerCompletion in class Shell.Command

getOptions

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

Overrides:

getOptions in class Shell.Command

usage

public java.lang.String usage()

Overrides:

usage in class Shell.Command

numArgs

public int numArgs()

Specified by:

numArgs in class Shell.Command