-
- All Known Implementing Classes:
AbstractCliCommand,CliCommandHelp,CliCommandVersion,NlsSynchronizer.Synchronizer
public interface CliCommandInterface 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 LocalizablegetHelp()Collection<CliProperty<?>>getProperties()intrun()Executes thisCliCommand.
-
-
-
Method Detail
-
getHelp
Localizable getHelp()
- Returns:
- the
Localizabledescribing this command.
-
getProperties
Collection<CliProperty<?>> getProperties()
- Returns:
- the available
propertiesof thisCliCommand.
-
run
int run()
Executes thisCliCommand.- Returns:
- the
exit code.
-
-