public interface Command
run(String...)
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
Returns a description of the command.
|
java.util.Collection<HelpExample> |
getExamples()
Return some examples for the command.
|
java.lang.String |
getHelp()
Gets full help text for the command, e.g.
|
java.lang.String |
getName()
Returns the name of the command.
|
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.
|
java.lang.String getName()
java.lang.String getDescription()
java.lang.String getUsageHelp()
java.lang.String getHelp()
java.util.Collection<OptionHelp> getOptionsHelp()
java.util.Collection<HelpExample> getExamples()
ExitStatus run(java.lang.String... args) throws java.lang.Exception
args
- command arguments (this will not include the command itself)java.lang.Exception
- if the command fails