| Interface | Description |
|---|---|
| CommandCallable |
A command that can be executed.
|
| CommandMapping |
Provides information about a mapping between a command and its aliases.
|
| Description |
A description of a command, providing information on the command's
parameters, a short description, a help text, and usage information.
|
| Parameter |
Defines a parameter for a command.
|
| Class | Description |
|---|---|
| ImmutableCommandMapping |
An immutable command mapping instance.
|
| ImmutableDescription |
An immutable implementation of a Description.
|
| ImmutableDescription.Builder |
Builds instances of
ImmutableDescription. |
| ImmutableParameter |
An immutable implementation of
Parameter. |
| ImmutableParameter.Builder |
Creates instances of
ImmutableParameter. |
| Intake |
The starting point to using parts of Intake.
|
| OptionType |
Defines the type of parameter, whether it is positional, a flag, optional,
or required.
|
| Exception | Description |
|---|---|
| CommandException |
Thrown when an executed command raises an error or when execution of
the command failed.
|
| InvalidUsageException |
Thrown when a command is not used properly.
|
| InvocationCommandException |
Thrown when invocation of a command fails, wrapping the exception that
is thrown.
|
| Annotation Type | Description |
|---|---|
| Command |
Annotates a method that is to be registered as a command.
|
| Require |
Annotates a method that requires a permission check to be satisfied before
it can be executed by the caller.
|
Copyright © 2015. All Rights Reserved.