Annotation Type Usage
-
@Retention(RUNTIME) @Target(TYPE) @Documented public @interface Usage
An annotation with which the usage of the command can be configured. This usage can for example be displayed in an own help command.When using the
ParameterParser
, the usage string has to follow a pre-defined format that is described there.Alternatively to using this annotation the
Command.getUsage()
method can be overwritten. If that method is overwritten and this annotation is used, the method overwrite takes precedence. That method is also what should be used to retrieve the configured usage.- See Also:
Command.getUsage()
,ParameterParser
-
-
Element Detail
-
value
String value
Returns the usage of the annotated command.- Returns:
- the usage of the annotated command
-
-