public class HelpCommand extends AbstractCommand
Command used for 'help' requests.| Constructor and Description |
|---|
HelpCommand(CommandRunner commandRunner) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getHelp()
Gets full help text for the command, e.g.
|
java.util.Collection<OptionHelp> |
getOptionsHelp()
Returns help for each supported option.
|
java.lang.String |
getUsageHelp()
Returns usage help for the command.
|
ExitStatus |
run(java.lang.String... args)
Run the command.
|
getDescription, getExamples, getNamepublic HelpCommand(CommandRunner commandRunner)
public java.lang.String getUsageHelp()
CommandgetUsageHelp in interface CommandgetUsageHelp in class AbstractCommandpublic java.lang.String getHelp()
CommandgetHelp in interface CommandgetHelp in class AbstractCommandpublic java.util.Collection<OptionHelp> getOptionsHelp()
CommandgetOptionsHelp in interface CommandgetOptionsHelp in class AbstractCommandpublic ExitStatus run(java.lang.String... args) throws java.lang.Exception
Commandargs - command arguments (this will not include the command itself)java.lang.Exception - if the command fails