public interface Command
run(String...)
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Returns a description of the command.
|
Collection<HelpExample> |
getExamples()
Return some examples for the command.
|
String |
getHelp()
Gets full help text for the command, e.g.
|
String |
getName()
Returns the name of the command.
|
Collection<OptionHelp> |
getOptionsHelp()
Returns help for each supported option.
|
String |
getUsageHelp()
Returns usage help for the command.
|
ExitStatus |
run(String... args)
Run the command.
|
String getName()
String getDescription()
String getUsageHelp()
String getHelp()
Collection<OptionHelp> getOptionsHelp()
Collection<HelpExample> getExamples()
ExitStatus run(String... args) throws Exception
args
- command arguments (this will not include the command itself)Exception
- if the command failsCopyright © 2019 Pivotal Software, Inc.. All rights reserved.