| Annotation Type | Description |
|---|---|
| Command |
The main entrypoint to a command, which specifies the parent of any
command.
|
| CommandPlaceholder |
An annotation that takes the place of a
@Command of a OrphanCommand. |
| CommandPriority |
Defines an explicit priority for a certain method over other
methods that similarly define a priority in the same class.
|
| CommandPriority.Low |
Represents a command with a low priority.
|
| Default |
Adds a default value for a parameter when it is not supplied.
|
| Delimiter |
An annotation that marks that collection-based annotation, such as
List,
Set, or a T[] array type, should be parsed by splitting
the input based on the given Delimiter.value() in this annotation. |
| Dependency |
An annotation for fields and parameters used to inject dependencies into command classes.
|
| Description |
An annotation to give the
ExecutableCommand a description. |
| DistributeOnMethods |
Marks an annotation as distributable on methods.
|
| Flag |
An annotation to mark a parameter as a flag.
|
| Length |
An annotation that requires
String parameters to have size
in the range of Length.min() and Length.max() (both inclusive) |
| Named |
An annotation used to override the names of command parameters.
|
| NotSender |
Marks a parameter that comes at the very beginning of a command method
that it should not be evaluated as a sender, and should be treated
as if it were a standard command parameter,
|
| NotSender.ImpliesNotSender |
A marker annotation that is added to other annotations whose presence implies that
the parameter they are annotating is definitely not a sender parameter, for example
a
ParseWith. |
| Optional |
Marks a parameter as optional and does not need to be explicitly specified by
the sender.
|
| ParseWith |
An annotation that instructs Lamp that certain parameters should be
parsed using a specific
ParameterType or a ParameterType.Factory. |
| Range |
An annotation that marks a numerical parameter as required to be in a specific
range
|
| SecretCommand |
Marks a command as a "secret" command.
|
| Single |
Marker annotation to mark that a parameter should NOT be concatenated with the rest
of the command arguments (which is the default behavior for trailing
String
arguments). |
| Sized |
An annotation that marks that collection-based annotation, such as
List,
Set, or a T[] array type, should have size
in the range of Sized.min() and Sized.max() (both inclusive) |
| Subcommand |
Marks a method as a subcommand that has a parent.
|
| Suggest |
An annotation that specifies the suggestions that a parameter
will produce.
|
| SuggestWith |
An annotation that instructs Lamp that certain parameters should produce
suggestions using a specific
SuggestionProvider or a SuggestionProvider.Factory. |
| Switch |
Marks a (strictly)
boolean parameter as a "switch", whose value will be
set by "flags", such as "--silent", which will represent a boolean parameter
annotated with @Switch("silent"). |
| Usage |
An annotation to give the
ExecutableCommand a usage. |