-
@Target(TYPE) @Retention(RUNTIME) @Documented public @interface Cli
Class annotation used to declaratively specify a CLI
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String
name
Sets the name of the CLI i.e.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.Class<?>[]
commands
Defines the classes that provide top-level commands for the CLIjava.lang.Class<?>
defaultCommand
Defines the class that provides the default command for the CLIjava.lang.String
description
Sets the description of the CLIGroup[]
groups
Defines command groups for the CLIboolean
includeDefaultRestrictions
Sets whether the default global restrictions are appliedParser
parserConfiguration
Sets the parser configuration for the CLIjava.lang.Class<? extends GlobalRestriction>[]
restrictions
Defines the classes that provide global restrictions for the CLI
-
-
-
-
parserConfiguration
Parser parserConfiguration
Sets the parser configuration for the CLI- Returns:
- Parser Configuration
- Default:
- @com.github.rvesse.airline.annotations.Parser
-
-
-
groups
Group[] groups
Defines command groups for the CLI- Returns:
- Command groups
- Default:
- {}
-
-
-
restrictions
java.lang.Class<? extends GlobalRestriction>[] restrictions
Defines the classes that provide global restrictions for the CLI- Returns:
- Global restriction classes
- Default:
- {}
-
-