-
- All Known Implementing Classes:
AbstractCliCommand
,CliCommandHelp
,CliCommandVersion
,NlsSynchronizer.Synchronizer
public interface CliCommand
Interface for a single command of a command-line-interface (CLI). E.g. a help command triggered via "--help" or "-h" prints out the usage, while a version command triggered via "--version" or "-v" prints the program version.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Localizable
getHelp()
Collection<CliProperty<?>>
getProperties()
int
run()
Executes thisCliCommand
.
-
-
-
Method Detail
-
getHelp
Localizable getHelp()
- Returns:
- the
Localizable
describing this command.
-
getProperties
Collection<CliProperty<?>> getProperties()
- Returns:
- the available
properties
of thisCliCommand
.
-
run
int run()
Executes thisCliCommand
.- Returns:
- the
exit code
.
-
-