Class AbstractCommand
- java.lang.Object
- org.springframework.boot.cli.command.AbstractCommand
- All Implemented Interfaces:
Command
- Direct Known Subclasses:
HelpCommand
,HintCommand
,OptionParsingCommand
,PromptCommand
,ShellCommand
,VersionCommand
public abstract class AbstractCommand extends Object implements Command
AbstractCommand
implementation.
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractCommand(String name, String description)
Create a newAbstractCommand
instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
Constructor Detail
AbstractCommand
protected AbstractCommand(String name, String description)
Create a newAbstractCommand
instance.- Parameters:
name
- the name of the commanddescription
- the command description
Method Detail
getName
public String getName()
Description copied from interface:Command
Returns the name of the command.
getDescription
public String getDescription()
Description copied from interface:Command
Returns a description of the command.- Specified by:
getDescription
in interfaceCommand
- Returns:
- the command's description
getUsageHelp
public String getUsageHelp()
Description copied from interface:Command
Returns usage help for the command. This should be a simple one-line string describing basic usage. e.g. '[options] <file>'. Do not include the name of the command in this string.- Specified by:
getUsageHelp
in interfaceCommand
- Returns:
- the command's usage help
getHelp
public String getHelp()
Description copied from interface:Command
Gets full help text for the command, e.g. a longer description and one line per option.
getOptionsHelp
public Collection<OptionHelp> getOptionsHelp()
Description copied from interface:Command
Returns help for each supported option.- Specified by:
getOptionsHelp
in interfaceCommand
- Returns:
- help for each of the command's options
getExamples
public Collection<HelpExample> getExamples()
Description copied from interface:Command
Return some examples for the command.- Specified by:
getExamples
in interfaceCommand
- Returns:
- the command's examples