Module com.github.rvesse.airline
Annotation Type Group
-
@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented public @interface GroupMarks a class as providing command group metadata
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.StringnameName of the group.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.Class<?>[]commandsCommand classes to add to the group (optional)java.lang.Class<?>defaultCommandDefault command class for the group (optional)java.lang.StringdescriptionDescription of the group.booleanhiddenWhether the group should be hidden
-
-
-
Element Detail
-
name
java.lang.String name
Name of the group.If the name contains spaces then this is interpreted as a sub-group, for example
foo barwould be interpreted as a groupfoowith a sub-groupbar. All the other fields on this annotation are interpreted as applying to the sub-group being specified.If you also wished to place commands into the
foogroup you would need to specify this separately. Since only one instance of an annotation can appear on any given class you would need to use theGroupsannotation to place multipleGroupannotations on a class.- Returns:
- Name
-
-
-
hidden
boolean hidden
Whether the group should be hidden- Returns:
- True if hidden, false otherwise
- Default:
- false
-
-