Module com.github.rvesse.airline
Annotation Type Command
-
@Target(TYPE) @Retention(RUNTIME) @Documented public @interface Command
Marks a class as a command
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String
name
Name of the command
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
description
Description of the commandjava.lang.String[]
groupNames
The group(s) this command should belong to.boolean
hidden
If true, this command won't appear in help
-
-
-
hidden
boolean hidden
If true, this command won't appear in help- Returns:
- Whether this command is hidden
- Default:
- false
-
-
-
groupNames
java.lang.String[] groupNames
The group(s) this command should belong to. if left empty the command will belong to the default command groupIf a group name contains spaces then this is interpreted as referring to a sub-group, for example
foo bar
would place this command into thebar
group which would be placed as a sub-group of thefoo
group.- Returns:
- Command groups
- Default:
- {}
-