public abstract class AbstractCommand extends Object implements Command
Command implementation.| Modifier | Constructor and Description |
|---|---|
protected |
AbstractCommand(String name,
String description)
Create a new
AbstractCommand instance. |
| 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.
|
protected AbstractCommand(String name, String description)
AbstractCommand instance.name - the name of the commanddescription - the command descriptionpublic String getName()
Commandpublic String getDescription()
CommandgetDescription in interface Commandpublic String getUsageHelp()
CommandgetUsageHelp in interface Commandpublic String getHelp()
Commandpublic Collection<OptionHelp> getOptionsHelp()
CommandgetOptionsHelp in interface Commandpublic Collection<HelpExample> getExamples()
CommandgetExamples in interface CommandCopyright © 2018 Pivotal Software, Inc.. All rights reserved.