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, getNamepublic HelpCommand(CommandRunner commandRunner)
public String getUsageHelp()
CommandgetUsageHelp in interface CommandgetUsageHelp in class AbstractCommandpublic String getHelp()
CommandgetHelp in interface CommandgetHelp in class AbstractCommandpublic Collection<OptionHelp> getOptionsHelp()
CommandgetOptionsHelp in interface CommandgetOptionsHelp in class AbstractCommandpublic ExitStatus run(String... args) throws Exception
Commandargs - command arguments (this will not include the command itself)Exception - if the command failsCopyright © 2020 Pivotal Software, Inc.. All rights reserved.