A C D F G H M N P R S V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- aliases() - Method in annotation type cloud.commandframework.annotations.Flag
-
Flag aliases
- AnnotationParser<C> - Class in cloud.commandframework.annotations
-
Parser that parses class instances
commands - AnnotationParser(CommandManager<C>, Class<C>, Function<ParserParameters, CommandMeta>) - Constructor for class cloud.commandframework.annotations.AnnotationParser
-
Construct a new annotation parser
- apply(CommandContext<C>, String) - Method in class cloud.commandframework.annotations.suggestions.MethodSuggestionsProvider
- Argument - Annotation Type in cloud.commandframework.annotations
-
Annotation used to indicate that a method parameter is a command argument
C
- cloud.commandframework.annotations - package cloud.commandframework.annotations
-
Annotation parsing related classes
- cloud.commandframework.annotations.injection - package cloud.commandframework.annotations.injection
-
Classes related to parameter injection
- cloud.commandframework.annotations.parsers - package cloud.commandframework.annotations.parsers
-
Classes related to
Parserannotated methods - cloud.commandframework.annotations.suggestions - package cloud.commandframework.annotations.suggestions
-
Classes related to
Suggestionsannotated methods - CommandDescription - Annotation Type in cloud.commandframework.annotations
-
Maps to
StandardParameters.DESCRIPTION - CommandMethod - Annotation Type in cloud.commandframework.annotations
-
Used to declare a class method as a command method
- CommandPermission - Annotation Type in cloud.commandframework.annotations
-
Equivalent to
Command.Builder.permission(String) - Confirmation - Annotation Type in cloud.commandframework.annotations
-
Require confirmation for the command
D
- defaultValue() - Method in annotation type cloud.commandframework.annotations.Argument
-
Get the default value
- description() - Method in annotation type cloud.commandframework.annotations.Argument
-
The argument description
- description() - Method in annotation type cloud.commandframework.annotations.Flag
-
The argument description
F
- failureCaption() - Method in annotation type cloud.commandframework.annotations.Regex
-
Key for the caption used to generate the failure exception.
- Flag - Annotation Type in cloud.commandframework.annotations
-
Indicates that the parameter should be treated like a
CommandFlag.
G
- getParameterInjectorRegistry() - Method in class cloud.commandframework.annotations.AnnotationParser
-
Get the parameter injector registry instance that is used to inject non-
argumentparameters intoCommandMethodannotatedmethods
H
- hidden() - Method in annotation type cloud.commandframework.annotations.ProxiedBy
-
Whether or not the proxying command should be
Hidden - Hidden - Annotation Type in cloud.commandframework.annotations
-
Indicates that the command should be hidden.
M
- MethodArgumentParser<C,T> - Class in cloud.commandframework.annotations.parsers
-
Represents a method annotated with
Parser - MethodArgumentParser(BiFunction<CommandContext<C>, String, List<String>>, Object, Method) - Constructor for class cloud.commandframework.annotations.parsers.MethodArgumentParser
-
Create a new parser
- MethodSuggestionsProvider<C> - Class in cloud.commandframework.annotations.suggestions
-
Represents a method annotated with
Suggestions - MethodSuggestionsProvider(Object, Method) - Constructor for class cloud.commandframework.annotations.suggestions.MethodSuggestionsProvider
-
Create a new provider
N
- name() - Method in annotation type cloud.commandframework.annotations.parsers.Parser
-
The name of the parser.
P
- parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.annotations.parsers.MethodArgumentParser
- parse(T) - Method in class cloud.commandframework.annotations.AnnotationParser
-
Scan a class instance of
CommandMethodannotations and attempt to compile them intoCommandinstances - Parser - Annotation Type in cloud.commandframework.annotations.parsers
-
This annotation allows you to create annotated methods that behave like argument parsers.
- parserName() - Method in annotation type cloud.commandframework.annotations.Argument
-
Name of the argument parser
- parserName() - Method in annotation type cloud.commandframework.annotations.Flag
-
Name of the parser.
- ProxiedBy - Annotation Type in cloud.commandframework.annotations
-
Creates a command proxy for the command.
R
- RawArgs - Annotation Type in cloud.commandframework.annotations.injection
-
Used to inject
CommandContext.getRawInput()into aCommandMethod - Regex - Annotation Type in cloud.commandframework.annotations
-
Annotation version of adding
RegexPreprocessoras a preprocessor usingCommandArgument.addPreprocessor(BiFunction) - registerAnnotationMapper(Class<A>, Function<A, ParserParameters>) - Method in class cloud.commandframework.annotations.AnnotationParser
-
Register an annotation mapper
- registerBuilderModifier(Class<A>, BiFunction<A, Command.Builder<C>, Command.Builder<C>>) - Method in class cloud.commandframework.annotations.AnnotationParser
-
Register a builder modifier for a specific annotation.
- registerPreprocessorMapper(Class<A>, Function<A, BiFunction<CommandContext<C>, Queue<String>, ArgumentParseResult<Boolean>>>) - Method in class cloud.commandframework.annotations.AnnotationParser
-
Register a preprocessor mapper
- requiredSender() - Method in annotation type cloud.commandframework.annotations.CommandMethod
-
The required sender
S
- suggestions() - Method in annotation type cloud.commandframework.annotations.Argument
-
Name of the suggestions provider to use.
- suggestions() - Method in annotation type cloud.commandframework.annotations.Flag
-
Name of the suggestions provider to use.
- suggestions() - Method in annotation type cloud.commandframework.annotations.parsers.Parser
-
Name of the suggestions provider to use.
- suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.annotations.parsers.MethodArgumentParser
- Suggestions - Annotation Type in cloud.commandframework.annotations.suggestions
-
This annotation allows you to create annotated methods that behave like suggestions providers.
V
- value() - Method in annotation type cloud.commandframework.annotations.Argument
-
Argument name
- value() - Method in annotation type cloud.commandframework.annotations.CommandDescription
-
Command description
- value() - Method in annotation type cloud.commandframework.annotations.CommandMethod
-
Command syntax
- value() - Method in annotation type cloud.commandframework.annotations.CommandPermission
-
Get the command permission
- value() - Method in annotation type cloud.commandframework.annotations.Flag
-
The flag name
- value() - Method in annotation type cloud.commandframework.annotations.ProxiedBy
-
Syntax of the proxying command
- value() - Method in annotation type cloud.commandframework.annotations.Regex
-
Regular expression pattern
- value() - Method in annotation type cloud.commandframework.annotations.suggestions.Suggestions
-
Name of the suggestions provider.
All Classes All Packages