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, getName
public HelpCommand(CommandRunner commandRunner)
public java.lang.String getUsageHelp()
Command
getUsageHelp
in interface Command
getUsageHelp
in class AbstractCommand
public java.lang.String getHelp()
Command
getHelp
in interface Command
getHelp
in class AbstractCommand
public java.util.Collection<OptionHelp> getOptionsHelp()
Command
getOptionsHelp
in interface Command
getOptionsHelp
in class AbstractCommand
public ExitStatus run(java.lang.String... args) throws java.lang.Exception
Command
args
- command arguments (this will not include the command itself)java.lang.Exception
- if the command fails