Module com.github.rvesse.airline
Annotation Interface Cli
Class annotation used to declaratively specify a CLI
-
Nested Class Summary
Nested Classes -
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass<?>[]
Defines the classes that provide top-level commands for the CLIClass
<?> Defines the class that provides the default command for the CLISets the description of the CLIGroup[]
Defines command groups for the CLIboolean
Sets whether the default global restrictions are appliedSets the parser configuration for the CLIClass<? extends GlobalRestriction>[]
Defines the classes that provide global restrictions for the CLI
-
Element Details
-
name
String nameSets the name of the CLI i.e. the command name users enter to invoke your CLI- Returns:
- Name
-
description
String descriptionSets the description of the CLI- Returns:
- Description
- Default:
""
-
parserConfiguration
Parser parserConfigurationSets the parser configuration for the CLI- Returns:
- Parser Configuration
- Default:
@com.github.rvesse.airline.annotations.Parser
-
groups
Group[] groupsDefines command groups for the CLI- Returns:
- Command groups
- Default:
{}
-
defaultCommand
Class<?> defaultCommandDefines the class that provides the default command for the CLI- Returns:
- Default command class
- Default:
com.github.rvesse.airline.annotations.Cli.NO_DEFAULT.class
-
commands
Class<?>[] commandsDefines the classes that provide top-level commands for the CLI- Returns:
- Top-level command classes
- Default:
{}
-
restrictions
Class<? extends GlobalRestriction>[] restrictionsDefines the classes that provide global restrictions for the CLI- Returns:
- Global restriction classes
- Default:
{}
-
includeDefaultRestrictions
boolean includeDefaultRestrictionsSets whether the default global restrictions are applied- Returns:
- True if default restrictions are applied, false otherwise
- Default:
true
-