Index

A C D E F G H I M N P R S V
All Classes and Interfaces|All Packages|Constant Field Values

A

aliases() - Element in annotation type cloud.commandframework.annotations.Flag

Flag aliases

annotationAccessor() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

The annotation accessor for the command method

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 Parser annotated methods

cloud.commandframework.annotations.suggestions - package cloud.commandframework.annotations.suggestions

Classes related to Suggestions annotated methods

commandArguments() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler.CommandMethodContext

The compiled command arguments

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

context() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

Returns the command method context

createParameterValues(CommandContext<C>, FlagContext, Parameter[]) - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

Creates a list containing the values for the given method parameters.

D

defaultValue() - Element in annotation type cloud.commandframework.annotations.Argument

Get the default value

description() - Element in annotation type cloud.commandframework.annotations.Argument

The argument description

description() - Element in annotation type cloud.commandframework.annotations.Flag

The argument description

E

execute(CommandContext<C>) - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

F

failureCaption() - Element 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-argument parameters into CommandMethod annotated methods

H

hidden() - Element 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.

I

INFERRED_ARGUMENT_NAME - Static variable in class cloud.commandframework.annotations.AnnotationParser

The value of Argument that should be used to infer argument names from parameter names.

injectorRegistry() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler.CommandMethodContext

The injector registry

instance() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler.CommandMethodContext

The instance that owns the command method

M

manager() - Method in class cloud.commandframework.annotations.AnnotationParser

Returns the command manager that was used to create this parser

method() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler.CommandMethodContext

The command method

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

MethodCommandExecutionHandler<C> - Class in cloud.commandframework.annotations

A command execution handler that invokes a method.

MethodCommandExecutionHandler(MethodCommandExecutionHandler.CommandMethodContext<C>) - Constructor for class cloud.commandframework.annotations.MethodCommandExecutionHandler

Constructs a new method command execution handler

MethodCommandExecutionHandler.CommandMethodContext<C> - Class in cloud.commandframework.annotations

Context for command methods

methodHandle() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

Returns the compiled method handle for the command method.

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() - Element in annotation type cloud.commandframework.annotations.parsers.Parser

The name of the parser.

P

parameters() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler

Returns all parameters passed to the method

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 CommandMethod annotations and attempt to compile them into Command instances

Parser - Annotation Type in cloud.commandframework.annotations.parsers

This annotation allows you to create annotated methods that behave like argument parsers.

parserName() - Element in annotation type cloud.commandframework.annotations.Argument

Name of the argument parser

parserName() - Element in annotation type cloud.commandframework.annotations.Flag

Name of the parser.

permission() - Element in annotation type cloud.commandframework.annotations.Flag

The flag permission

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 a CommandMethod

Regex - Annotation Type in cloud.commandframework.annotations

Annotation version of adding RegexPreprocessor as a preprocessor using CommandArgument.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.

registerCommandExecutionMethodFactory(Predicate<Method>, Function<MethodCommandExecutionHandler.CommandMethodContext<C>, MethodCommandExecutionHandler<C>>) - Method in class cloud.commandframework.annotations.AnnotationParser

Registers a new command execution method factory.

registerPreprocessorMapper(Class<A>, Function<A, BiFunction<CommandContext<C>, Queue<String>, ArgumentParseResult<Boolean>>>) - Method in class cloud.commandframework.annotations.AnnotationParser

Register a preprocessor mapper

requiredSender() - Element in annotation type cloud.commandframework.annotations.CommandMethod

The required sender

S

suggestions() - Element in annotation type cloud.commandframework.annotations.Argument

Name of the suggestions provider to use.

suggestions() - Element in annotation type cloud.commandframework.annotations.Flag

Name of the suggestions provider to use.

suggestions() - Element 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() - Element in annotation type cloud.commandframework.annotations.Argument

The name of the argument that this parameter is bound to.

value() - Element in annotation type cloud.commandframework.annotations.CommandDescription

Command description

value() - Element in annotation type cloud.commandframework.annotations.CommandMethod

Command syntax

value() - Element in annotation type cloud.commandframework.annotations.CommandPermission

Get the command permission

value() - Element in annotation type cloud.commandframework.annotations.Flag

The flag name

value() - Element in annotation type cloud.commandframework.annotations.ProxiedBy

Syntax of the proxying command

value() - Element in annotation type cloud.commandframework.annotations.Regex

Regular expression pattern

value() - Element in annotation type cloud.commandframework.annotations.suggestions.Suggestions

Name of the suggestions provider.

A C D E F G H I M N P R S V
All Classes and Interfaces|All Packages|Constant Field Values