public class HelpCommand extends AbstractCommand
Command
used for 'help' requests.Constructor and Description |
---|
HelpCommand(CommandRunner commandRunner) |
Modifier and Type | Method and Description |
---|---|
String |
getHelp()
Gets full help text for the command, e.g.
|
Collection<OptionHelp> |
getOptionsHelp()
Returns help for each supported option.
|
String |
getUsageHelp()
Returns usage help for the command.
|
ExitStatus |
run(String... args)
Run the command.
|
getDescription, getExamples, getName
public HelpCommand(CommandRunner commandRunner)
public String getUsageHelp()
Command
getUsageHelp
in interface Command
getUsageHelp
in class AbstractCommand
public String getHelp()
Command
getHelp
in interface Command
getHelp
in class AbstractCommand
public Collection<OptionHelp> getOptionsHelp()
Command
getOptionsHelp
in interface Command
getOptionsHelp
in class AbstractCommand
public ExitStatus run(String... args) throws Exception
Command
args
- command arguments (this will not include the command itself)Exception
- if the command failsCopyright © 2019 Pivotal Software, Inc.. All rights reserved.