com.github.rvesse.airline.annotations

Annotation Type Group

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface Group

Marks a class as providing command group metadata

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Name of the group.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	commands Command classes to add to the group (optional)
Class<?>	defaultCommand Default command class for the group (optional)
String	description Description of the group.
boolean	hidden Whether the group should be hidden

Element Detail

name

public abstract String name

Name of the group.

If the name contains spaces then this is interpreted as a sub-group, for example foo bar would be interpreted as a group foo with a sub-group bar. 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 foo group 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 the Groups annotation to place multiple Group annotations on a class.

Returns:

Name

description

public abstract String description

Description of the group.

Returns:

Description

Default:

""

defaultCommand

public abstract Class<?> defaultCommand

Default command class for the group (optional)

Returns:

Default Command for the group

Default:

com.github.rvesse.airline.annotations.Group.NO_DEFAULT.class

commands

public abstract Class<?>[] commands

Command classes to add to the group (optional)

Returns:

Command classes for the group

Default:

{}

hidden

public abstract boolean hidden

Whether the group should be hidden

Returns:

True if hidden, false otherwise

Default:

false