Index (cloud-annotations 1.7.0 API)

A C D E F G H I L M N O 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
ANNOTATION_PATH - Static variable in annotation type cloud.commandframework.annotations.CommandMethod
ANNOTATION_PATH - Static variable in annotation type cloud.commandframework.annotations.processing.CommandContainer
annotationAccessor() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler: The annotation accessor for the command method
annotationParser() - Method in class cloud.commandframework.annotations.MethodCommandExecutionHandler.CommandMethodContext: The annotation parser
AnnotationParser<C> - Class in cloud.commandframework.annotations: Parser that parses class instances commands
AnnotationParser(CommandManager<C>, TypeToken<C>, Function<ParserParameters, CommandMeta>) - Constructor for class cloud.commandframework.annotations.AnnotationParser: Construct a new annotation parser
AnnotationParser(CommandManager<C>, Class<C>, Function<ParserParameters, CommandMeta>) - Constructor for class cloud.commandframework.annotations.AnnotationParser: Construct a new annotation parser
apply(String) - Method in class cloud.commandframework.annotations.SyntaxParser
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
ArgumentMode - Enum in cloud.commandframework.annotations: The mode of an 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.processing - package cloud.commandframework.annotations.processing: Annotation-processing related classes.
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
CommandContainer - Annotation Type in cloud.commandframework.annotations.processing: Indicates that the class contains command metods.
CommandContainerProcessor - Class in cloud.commandframework.annotations.processing
CommandContainerProcessor() - Constructor for class cloud.commandframework.annotations.processing.CommandContainerProcessor
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
CommandMethodProcessor - Class in cloud.commandframework.annotations.processing
CommandMethodProcessor() - Constructor for class cloud.commandframework.annotations.processing.CommandMethodProcessor
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

getArgumentMode() - Method in class cloud.commandframework.annotations.SyntaxFragment: Returns the argument mode.
getMajor() - Method in class cloud.commandframework.annotations.SyntaxFragment: Returns the major portion of the fragment.
getMinor() - Method in class cloud.commandframework.annotations.SyntaxFragment: Returns the minor part of the fragment.
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
getSupportedSourceVersion() - Method in class cloud.commandframework.annotations.processing.CommandContainerProcessor
getSupportedSourceVersion() - Method in class cloud.commandframework.annotations.processing.CommandMethodProcessor

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

L

LITERAL - Enum constant in enum cloud.commandframework.annotations.ArgumentMode

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.
noOp() - Static method in interface cloud.commandframework.annotations.StringProcessor: Returns a string processor that simply returns the input string.
NoOpStringProcessor() - Constructor for class cloud.commandframework.annotations.StringProcessor.NoOpStringProcessor

O

OPTIONAL - Enum constant in enum cloud.commandframework.annotations.ArgumentMode

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.
parseContainers() - Method in class cloud.commandframework.annotations.AnnotationParser: Parses all known command containers.
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.
PATH - Static variable in class cloud.commandframework.annotations.processing.CommandContainerProcessor: The file in which all command container names are stored.
PatternReplacingStringProcessor - Class in cloud.commandframework.annotations: StringProcessor that replaces matches of a given Pattern.
PatternReplacingStringProcessor(Pattern, Function<MatchResult, String>) - Constructor for class cloud.commandframework.annotations.PatternReplacingStringProcessor: Creates a new property replacing string processor.
permission() - Element in annotation type cloud.commandframework.annotations.Flag: The flag permission
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class cloud.commandframework.annotations.processing.CommandContainerProcessor
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class cloud.commandframework.annotations.processing.CommandMethodProcessor
processString(String) - Method in class cloud.commandframework.annotations.AnnotationParser: Processes the input string and returns the processed result.
processString(String) - Method in class cloud.commandframework.annotations.PatternReplacingStringProcessor: Processes the input string and returns the processed result.
processString(String) - Method in class cloud.commandframework.annotations.StringProcessor.NoOpStringProcessor
processString(String) - Method in interface cloud.commandframework.annotations.StringProcessor: Processes the input string and returns the processed result.
processStrings(String[]) - Method in class cloud.commandframework.annotations.AnnotationParser: Processes the input strings and returns the processed result.
PROPERTY_REGEX - Static variable in class cloud.commandframework.annotations.PropertyReplacingStringProcessor
PropertyReplacingStringProcessor - Class in cloud.commandframework.annotations: PropertyReplacingStringProcessor.PropertyReplacementProvider that replaces all sub-strings with the format ${some.property} with a function-generated string.
PropertyReplacingStringProcessor(Function<String, String>) - Constructor for class cloud.commandframework.annotations.PropertyReplacingStringProcessor: Creates a new property replacing string processor.
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
repeatable() - Element in annotation type cloud.commandframework.annotations.Flag: Whether the flag can be repeated.
REQUIRED - Enum constant in enum cloud.commandframework.annotations.ArgumentMode
requiredSender() - Element in annotation type cloud.commandframework.annotations.CommandMethod: The required sender

S

stringProcessor() - Method in class cloud.commandframework.annotations.AnnotationParser: Returns the string processor used by this parser.
stringProcessor(StringProcessor) - Method in class cloud.commandframework.annotations.AnnotationParser: Replaces the string processor of this parser.
StringProcessor - Interface in cloud.commandframework.annotations: Processor that intercepts all cloud annotation strings.
StringProcessor.NoOpStringProcessor - Class in cloud.commandframework.annotations
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.
SyntaxFragment - Class in cloud.commandframework.annotations: Public since 1.7.0.
SyntaxParser - Class in cloud.commandframework.annotations: Parses command syntax into syntax fragments.
SyntaxParser() - Constructor for class cloud.commandframework.annotations.SyntaxParser

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.
valueOf(String) - Static method in enum cloud.commandframework.annotations.ArgumentMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum cloud.commandframework.annotations.ArgumentMode: Returns an array containing the constants of this enum type, in the order they are declared.

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