Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addAllSyntax(Iterable<? extends SyntaxFragment>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Adds elements to
syntaxlist. - addSyntax(SyntaxFragment) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Adds one element to
syntaxlist. - addSyntax(SyntaxFragment...) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Adds elements to
syntaxlist. - aliases() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns an unmodifiable view of the flag aliases.
- aliases() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns an unmodifiable view of the flag aliases.
- aliases() - Element in annotation type org.incendo.cloud.annotations.Flag
-
Flag aliases
- aliases(Collection<String>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
aliasesattribute. - ALL_OF - Enum constant in enum org.incendo.cloud.annotations.Permission.Mode
-
All permissions defined in
Permission.value()are required. - AnnotatedMethodHandler<C> - Class in org.incendo.cloud.annotations.method
-
Handler that invokes an annotated method.
- AnnotatedMethodHandler(Method, Object, ParameterInjectorRegistry<C>) - Constructor for class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
- AnnotatedMethodHandlerInitiationException - Exception Class in org.incendo.cloud.annotations.method
-
Exception thrown when a
AnnotatedMethodHandlerfails to initiate. - ANNOTATION_PATH - Static variable in annotation type org.incendo.cloud.annotations.Command
- ANNOTATION_PATH - Static variable in annotation type org.incendo.cloud.annotations.processing.CommandContainer
- annotationAccessor() - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the annotation accessor.
- AnnotationMapper<A> - Interface in org.incendo.cloud.annotations
-
Maps annotations to
parser parameters. - annotationParser() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Returns the annotation parser.
- annotationParser() - Method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns the annotation parser.
- annotationParser() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
The annotation parser
- annotationParser(AnnotationParser<?>) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor.Builder
-
Initializes the value for the
annotationParserattribute. - AnnotationParser<C> - Class in org.incendo.cloud.annotations
-
Parser that parses class instances
commands - AnnotationParser(CommandManager<C>, TypeToken<C>) - Constructor for class org.incendo.cloud.annotations.AnnotationParser
-
Construct a new annotation parser
- AnnotationParser(CommandManager<C>, TypeToken<C>, Function<ParserParameters, CommandMeta>) - Constructor for class org.incendo.cloud.annotations.AnnotationParser
-
Construct a new annotation parser
- AnnotationParser(CommandManager<C>, Class<C>) - Constructor for class org.incendo.cloud.annotations.AnnotationParser
-
Construct a new annotation parser
- AnnotationParser(CommandManager<C>, Class<C>, Function<ParserParameters, CommandMeta>) - Constructor for class org.incendo.cloud.annotations.AnnotationParser
-
Construct a new annotation parser
- ANY_OF - Enum constant in enum org.incendo.cloud.annotations.Permission.Mode
-
At least one of the permissions defined in
Permission.value()is required. - applicable(Command.Builder.Applicable<C>) - Static method in interface org.incendo.cloud.annotations.BuilderDecorator
-
Returns a
BuilderDecoratorapplies the givenapplicableto the command builders. - Argument - Annotation Type in org.incendo.cloud.annotations
-
Annotation used to indicate that a method parameter is a command argument.
- argumentAssembler() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the argument assembler.
- argumentAssembler(ArgumentAssembler<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the argument assembler
- ArgumentAssembler<C> - Interface in org.incendo.cloud.annotations.assembler
-
Assembles
command componetsfromargument descriptors. - ArgumentAssemblerImpl<C> - Class in org.incendo.cloud.annotations.assembler
- ArgumentAssemblerImpl(AnnotationParser<C>) - Constructor for class org.incendo.cloud.annotations.assembler.ArgumentAssemblerImpl
-
Creates a new argument assembler.
- ArgumentDescriptor - Interface in org.incendo.cloud.annotations.descriptor
- argumentDescriptors() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
Returns the argument descriptors
- argumentExtractor() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the argument extractor.
- argumentExtractor(ArgumentExtractor) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the argument extractor.
- ArgumentExtractor - Interface in org.incendo.cloud.annotations.extractor
-
Extracts
argument descriptorsfrommethods. - argumentMode() - Method in class org.incendo.cloud.annotations.SyntaxFragment
-
Returns the argument mode.
- ArgumentMode - Enum in org.incendo.cloud.annotations
-
The mode of an argument.
- assembleArgument(SyntaxFragment, ArgumentDescriptor) - Method in interface org.incendo.cloud.annotations.assembler.ArgumentAssembler
-
Assembles a command component from the given
descriptor. - assembleArgument(SyntaxFragment, ArgumentDescriptor) - Method in class org.incendo.cloud.annotations.assembler.ArgumentAssemblerImpl
- assembleFlag(FlagDescriptor) - Method in interface org.incendo.cloud.annotations.assembler.FlagAssembler
-
Assembles a flag from the given
descriptor. - assembleFlag(FlagDescriptor) - Method in class org.incendo.cloud.annotations.assembler.FlagAssemblerImpl
B
- build() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Builds a new
ImmutableArgumentDescriptor. - build() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Builds a new
ImmutableCommandDescriptor. - build() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Builds a new
ImmutableFlagDescriptor. - build() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor.Builder
-
Builds a new
ImmutableStandardArgumentExtractor. - builder() - Static method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Creates a new builder.
- builder() - Static method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Creates a new builder.
- builder() - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Creates a builder for
ImmutableArgumentDescriptor. - builder() - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Creates a builder for
ImmutableCommandDescriptor. - builder() - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Creates a builder for
ImmutableFlagDescriptor. - builder() - Static method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Creates a builder for
ImmutableStandardArgumentExtractor. - builder(AnnotationParser<?>) - Static method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns a builder that builds
StandardArgumentExtractorinstances. - builder(StandardArgumentExtractor) - Static method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns a builder that builds
StandardArgumentExtractorinstances. - BuilderDecorator<C> - Interface in org.incendo.cloud.annotations
-
Decorators that get to modify a command builder that is used to construct the command for annotated command methods.
- BuilderModifier<A,
C> - Interface in org.incendo.cloud.annotations
C
- Command - Annotation Type in org.incendo.cloud.annotations
-
Method that indicates that a method is a command method.
- commandComponents() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
The compiled command arguments
- CommandContainer - Annotation Type in org.incendo.cloud.annotations.processing
-
Indicates that the class contains
command metods. - CommandContainerProcessor - Class in org.incendo.cloud.annotations.processing
- CommandContainerProcessor() - Constructor for class org.incendo.cloud.annotations.processing.CommandContainerProcessor
- CommandDescription - Annotation Type in org.incendo.cloud.annotations
-
Annotation that modifies the command builder to invoke
Command.Builder.commandDescription(org.incendo.cloud.description.CommandDescription)usingCommandDescription.commandDescription(String). - CommandDescriptor - Interface in org.incendo.cloud.annotations.descriptor
- commandExtractor() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the command extractor.
- commandExtractor(CommandExtractor) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the command extractor.
- CommandExtractor - Interface in org.incendo.cloud.annotations.extractor
-
Extracts
command descriptorsfrom command class instances. - CommandExtractorImpl - Class in org.incendo.cloud.annotations.extractor
- CommandExtractorImpl(AnnotationParser<?>) - Constructor for class org.incendo.cloud.annotations.extractor.CommandExtractorImpl
-
Creates a new command extractor.
- CommandMethodExecutionHandlerFactory<C> - Interface in org.incendo.cloud.annotations
- CommandMethodProcessor - Class in org.incendo.cloud.annotations.processing
- CommandMethodProcessor() - Constructor for class org.incendo.cloud.annotations.processing.CommandMethodProcessor
- Commands - Annotation Type in org.incendo.cloud.annotations
-
Container for
Command. - commandToken() - Method in interface org.incendo.cloud.annotations.descriptor.CommandDescriptor
-
Returns the root command name.
- commandToken() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Returns the root command name.
- commandToken(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Initializes the value for the
commandTokenattribute. - constant(DefaultValue<C, T>) - Static method in interface org.incendo.cloud.annotations.DefaultValueFactory
-
Creates a default value factory that always returns the given
defaultValue. - context() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler
-
Returns the command method context
- copyOf(ArgumentDescriptor) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Creates an immutable copy of a
ArgumentDescriptorvalue. - copyOf(CommandDescriptor) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Creates an immutable copy of a
CommandDescriptorvalue. - copyOf(FlagDescriptor) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Creates an immutable copy of a
FlagDescriptorvalue. - copyOf(StandardArgumentExtractor) - Static method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Creates an immutable copy of a
StandardArgumentExtractorvalue. - create(Parameter) - Method in interface org.incendo.cloud.annotations.DefaultValueFactory
-
Creates the default value.
- create(AnnotationParser<?>) - Static method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns a
StandardArgumentExtractorwith the default options. - createArgumentParser(SuggestionProvider<C>, Object, Method, ParameterInjectorRegistry<C>) - Method in interface org.incendo.cloud.annotations.parser.MethodArgumentParserFactory
-
Creates a suggestion provider using the given
method. - createArgumentParser(SuggestionProvider<C>, Object, Method, ParameterInjectorRegistry<C>) - Method in class org.incendo.cloud.annotations.parser.MethodArgumentParserFactoryImpl
- createExceptionHandler(Object, Method, ParameterInjectorRegistry<C>) - Method in interface org.incendo.cloud.annotations.exception.ExceptionHandlerFactory
-
Creates an exception handler using the given
method. - createExecutionHandler(MethodCommandExecutionHandler.CommandMethodContext<C>) - Method in interface org.incendo.cloud.annotations.CommandMethodExecutionHandlerFactory
-
Creates an execution handler from the given
context. - createParameterValues(CommandContext<C>) - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Creates a list of values for the method
AnnotatedMethodHandler.parameters(). - createParameterValues(CommandContext<C>, Parameter[]) - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Creates a list of values for the given method
parameters. - createParameterValues(CommandContext<C>, Parameter[], Collection<Object>) - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Creates a list of values for the given method
parameters. - createSuggestionProvider(Object, Method, ParameterInjectorRegistry<C>) - Method in interface org.incendo.cloud.annotations.suggestion.SuggestionProviderFactory
-
Creates a suggestion provider using the given
method.
D
- decorate(Command.Builder<C>) - Method in interface org.incendo.cloud.annotations.BuilderDecorator
-
Decorates the given
builderand returns the result. - Default - Annotation Type in org.incendo.cloud.annotations
- defaultDescription(CommandDescription) - Static method in interface org.incendo.cloud.annotations.BuilderDecorator
-
Returns a
BuilderDecoratorthat sets the defaultdescriptionof a command. - defaultFactory() - Static method in interface org.incendo.cloud.annotations.exception.ExceptionHandlerFactory
-
Returns a factory that produces
MethodExceptionHandlerinstances. - defaultFactory() - Static method in interface org.incendo.cloud.annotations.parser.MethodArgumentParserFactory
-
Returns a factory that produces
MethodArgumentParserFactoryImplinstances. - defaultFactory() - Static method in interface org.incendo.cloud.annotations.suggestion.SuggestionProviderFactory
-
Returns a factory that produces
MethodSuggestionProviderinstances. - defaultPermission(Permission) - Static method in interface org.incendo.cloud.annotations.BuilderDecorator
-
Returns a
BuilderDecoratorthat sets the defaultpermissionof a command. - defaultValue() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the default value.
- defaultValue() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the default value.
- defaultValue(DefaultValue<?, ?>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
defaultValueattribute. - DefaultValueFactory<C,
T> - Interface in org.incendo.cloud.annotations -
Factory that produces default value instances.
- defaultValueRegistry() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the default value registry.
- defaultValueRegistry(DefaultValueRegistry<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the default value registry.
- DefaultValueRegistry<C> - Interface in org.incendo.cloud.annotations
-
Registry that stores mappings between names and
default value factories. - description() - Element in annotation type org.incendo.cloud.annotations.Argument
-
The argument description
- description() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the description of the argument.
- description() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the description of the flag.
- description() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the description of the argument.
- description() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the description of the flag.
- description() - Element in annotation type org.incendo.cloud.annotations.Flag
-
The argument description
- description(Description) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
descriptionattribute. - description(Description) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
descriptionattribute. - descriptionMapper() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the description mapper.
- descriptionMapper() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Returns the description mapper.
- descriptionMapper() - Method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns the description mapper.
- descriptionMapper(DescriptionMapper) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the description mapper.
- descriptionMapper(DescriptionMapper) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor.Builder
-
Initializes the value for the
descriptionMapperattribute. - DescriptionMapper - Interface in org.incendo.cloud.annotations
- descriptor() - Method in interface org.incendo.cloud.annotations.method.ParameterValue
-
Returns the associated descriptor.
- Descriptor - Interface in org.incendo.cloud.annotations.descriptor
E
- equals(Object) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
This instance is equal to all instances of
ImmutableArgumentDescriptorthat have equal attribute values. - equals(Object) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
This instance is equal to all instances of
ImmutableCommandDescriptorthat have equal attribute values. - equals(Object) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
This instance is equal to all instances of
ImmutableFlagDescriptorthat have equal attribute values. - equals(Object) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
This instance is equal to all instances of
ImmutableStandardArgumentExtractorthat have equal attribute values. - ExceptionHandler - Annotation Type in org.incendo.cloud.annotations.exception
-
Annotation used to map methods to
exception handlers. - exceptionHandlerFactory() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the exception provider factory.
- exceptionHandlerFactory(ExceptionHandlerFactory<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the exception provider factory.
- ExceptionHandlerFactory<C> - Interface in org.incendo.cloud.annotations.exception
- executeFuture(CommandContext<C>) - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler
- extract(Parameter) - Method in interface org.incendo.cloud.annotations.extractor.ParameterNameExtractor
-
Extracts the name from the given
parameter. - extractArguments(List<SyntaxFragment>, Method) - Method in interface org.incendo.cloud.annotations.extractor.ArgumentExtractor
-
Extracts the arguments from the given
method. - extractArguments(List<SyntaxFragment>, Method) - Method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
- extractCommands(Object) - Method in interface org.incendo.cloud.annotations.extractor.CommandExtractor
-
Extracts the commands from the given
instance. - extractCommands(Object) - Method in class org.incendo.cloud.annotations.extractor.CommandExtractorImpl
- extractFlags(Method) - Method in interface org.incendo.cloud.annotations.extractor.FlagExtractor
-
Extracts the flags from the given
method. - extractFlags(Method) - Method in class org.incendo.cloud.annotations.extractor.FlagExtractorImpl
F
- failureCaption() - Element in annotation type org.incendo.cloud.annotations.Regex
-
Key for the caption used to generate the failure exception.
- Flag - Annotation Type in org.incendo.cloud.annotations
-
Indicates that the parameter should be treated like a
CommandFlag. - flagAssembler() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the flag assembler.
- flagAssembler(FlagAssembler) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the flag assembler
- FlagAssembler - Interface in org.incendo.cloud.annotations.assembler
-
Assembles
flagsfromflag descriptors. - FlagAssemblerImpl - Class in org.incendo.cloud.annotations.assembler
- FlagAssemblerImpl(CommandManager<?>) - Constructor for class org.incendo.cloud.annotations.assembler.FlagAssemblerImpl
-
Creates a new flag assembler.
- FlagDescriptor - Interface in org.incendo.cloud.annotations.descriptor
- flagDescriptors() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
Returns the flag descriptors
- flagExtractor() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the flag extractor.
- flagExtractor(FlagExtractor) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the flag extractor.
- FlagExtractor - Interface in org.incendo.cloud.annotations.extractor
-
Extractor that extracts
flag descriptorsfrom command methods. - FlagExtractorImpl - Class in org.incendo.cloud.annotations.extractor
- FlagExtractorImpl(AnnotationParser<?>) - Constructor for class org.incendo.cloud.annotations.extractor.FlagExtractorImpl
-
Creates a new flag extractor.
- from(ArgumentDescriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.ArgumentDescriptorinstance. - from(CommandDescriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.CommandDescriptorinstance. - from(Descriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.Descriptorinstance. - from(Descriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.Descriptorinstance. - from(Descriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.Descriptorinstance. - from(FlagDescriptor) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Fill a builder with attribute values from the provided
org.incendo.cloud.annotations.descriptor.FlagDescriptorinstance. - from(StandardArgumentExtractor) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor.Builder
-
Fill a builder with attribute values from the provided
StandardArgumentExtractorinstance.
G
- getInjectedValue(Parameter, CommandContext<C>) - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the injected value for the given
parameter, if possible. - getParameterValue(Parameter, CommandContext<C>) - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the value for the given
parameter, if possible. - getParameterValue(Parameter, CommandContext<C>) - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler
- getSupportedSourceVersion() - Method in class org.incendo.cloud.annotations.processing.CommandContainerProcessor
- getSupportedSourceVersion() - Method in class org.incendo.cloud.annotations.processing.CommandMethodProcessor
H
- handle(ExceptionContext<C, Throwable>) - Method in class org.incendo.cloud.annotations.exception.MethodExceptionHandler
- hashCode() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Computes a hash code from attributes:
parameter,name,parserName,suggestions,defaultValue,description. - hashCode() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Computes a hash code from attributes:
method,name,syntax,commandToken,requiredSender. - hashCode() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Computes a hash code from attributes:
parameter,name,aliases,parserName,suggestions,permission,description,repeatable. - hashCode() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Computes a hash code from attributes:
annotationParser,parameterNameExtractor,descriptionMapper.
I
- ImmutableArgumentDescriptor - Class in org.incendo.cloud.annotations.descriptor
-
Immutable implementation of
ArgumentDescriptor. - ImmutableArgumentDescriptor.Builder - Class in org.incendo.cloud.annotations.descriptor
-
Builds instances of type
ImmutableArgumentDescriptor. - ImmutableCommandDescriptor - Class in org.incendo.cloud.annotations.descriptor
-
Immutable implementation of
CommandDescriptor. - ImmutableCommandDescriptor.Builder - Class in org.incendo.cloud.annotations.descriptor
-
Builds instances of type
ImmutableCommandDescriptor. - ImmutableFlagDescriptor - Class in org.incendo.cloud.annotations.descriptor
-
Immutable implementation of
FlagDescriptor. - ImmutableFlagDescriptor.Builder - Class in org.incendo.cloud.annotations.descriptor
-
Builds instances of type
ImmutableFlagDescriptor. - ImmutableStandardArgumentExtractor - Class in org.incendo.cloud.annotations.extractor
-
Immutable implementation of
StandardArgumentExtractor. - ImmutableStandardArgumentExtractor.Builder - Class in org.incendo.cloud.annotations.extractor
-
Builds instances of type
ImmutableStandardArgumentExtractor. - INFERRED_ARGUMENT_NAME - Static variable in class org.incendo.cloud.annotations.AnnotationParser
-
The value of
Argumentthat should be used to infer argument names from parameter names. - injectorRegistry() - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the parameter injector registry.
- injectorRegistry() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
The injector registry
- instance() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
The instance that owns the command method
L
- LITERAL - Enum constant in enum org.incendo.cloud.annotations.ArgumentMode
M
- major() - Method in class org.incendo.cloud.annotations.SyntaxFragment
-
Returns the major portion of the fragment.
- manager() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the command manager that was used to create this parser
- map(String) - Method in interface org.incendo.cloud.annotations.DescriptionMapper
-
Maps the given
stringto aDescription. - mapAnnotation(A) - Method in interface org.incendo.cloud.annotations.AnnotationMapper
-
Maps the given
annotationtoparser parameters. - mapAnnotation(A) - Method in interface org.incendo.cloud.annotations.PreprocessorMapper
-
Maps the given
annotationto aargument preprocessor. - mapCompleted(Object) - Static method in class org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider
-
Maps the input to a list of suggestions.
- mapDescription(String) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Maps the given
stringinto aDescription. - mapFuture(CompletableFuture) - Static method in class org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider
-
Maps the future to a future of suggestions.
- mapSuggestions(Object) - Static method in class org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider
-
Maps the suggestions to a future of a list of suggestions.
- method() - Method in interface org.incendo.cloud.annotations.descriptor.CommandDescriptor
-
Returns the command method.
- method() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Returns the command method.
- method() - Method in class org.incendo.cloud.annotations.MethodCommandExecutionHandler.CommandMethodContext
-
The command method
- method(Method) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Initializes the value for the
methodattribute. - MethodArgumentParser<C,
T> - Class in org.incendo.cloud.annotations.parser -
Represents a method annotated with
Parser - MethodArgumentParser(SuggestionProvider<C>, Object, Method, ParameterInjectorRegistry<C>) - Constructor for class org.incendo.cloud.annotations.parser.MethodArgumentParser
-
Creates a new parser.
- methodArgumentParserFactory() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the method argument parser factory.
- methodArgumentParserFactory(MethodArgumentParserFactory<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the method argument parser factory.
- MethodArgumentParserFactory<C> - Interface in org.incendo.cloud.annotations.parser
- MethodArgumentParserFactoryImpl<C> - Class in org.incendo.cloud.annotations.parser
-
Represents a method argument parser annotated with
Parser - MethodArgumentParserFactoryImpl() - Constructor for class org.incendo.cloud.annotations.parser.MethodArgumentParserFactoryImpl
- MethodCommandExecutionHandler<C> - Class in org.incendo.cloud.annotations
-
A command execution handler that invokes a method.
- MethodCommandExecutionHandler(MethodCommandExecutionHandler.CommandMethodContext<C>) - Constructor for class org.incendo.cloud.annotations.MethodCommandExecutionHandler
-
Constructs a new method command execution handler
- MethodCommandExecutionHandler.CommandMethodContext<C> - Class in org.incendo.cloud.annotations
-
Context for command methods
- MethodExceptionHandler<C> - Class in org.incendo.cloud.annotations.exception
-
Represents a method annotated with
ExceptionHandler. - MethodExceptionHandler(Object, Method, ParameterInjectorRegistry<C>) - Constructor for class org.incendo.cloud.annotations.exception.MethodExceptionHandler
-
Creates a new handler.
- methodHandle() - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the method handle.
- MethodSuggestionProvider<C> - Class in org.incendo.cloud.annotations.suggestion
-
Represents a method annotated with
Suggestions - MethodSuggestionProvider(Object, Method, ParameterInjectorRegistry<C>) - Constructor for class org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider
-
Creates a new provider.
- minor() - Method in class org.incendo.cloud.annotations.SyntaxFragment
-
Returns the minor part of the fragment.
- mode() - Element in annotation type org.incendo.cloud.annotations.Permission
-
Returns the permission mode.
- modifyBuilder(A, Command.Builder<C>) - Method in interface org.incendo.cloud.annotations.BuilderModifier
-
Modifies the command
builderand returns the updated builder.
N
- name() - Element in annotation type org.incendo.cloud.annotations.Default
-
If used on a parameter this returns the name of the
DefaultValueFactoryused to create the default value. - name() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the argument name
- name() - Method in interface org.incendo.cloud.annotations.descriptor.CommandDescriptor
- name() - Method in interface org.incendo.cloud.annotations.descriptor.Descriptor
-
Returns the name of the object described by
thisdescriptor. - name() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the flag name.
- name() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the argument name
- name() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
- name() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the flag name.
- name() - Element in annotation type org.incendo.cloud.annotations.parser.Parser
-
Returns name of the parser.
- name(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
nameattribute. - name(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Initializes the value for the
nameattribute. - name(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
nameattribute. - named(String) - Method in interface org.incendo.cloud.annotations.DefaultValueRegistry
-
Returns the default value with the given
name, if it exists. - noOp() - Static method in interface org.incendo.cloud.annotations.string.StringProcessor
-
Returns a string processor that simply returns the input string.
- NoOpStringProcessor() - Constructor for class org.incendo.cloud.annotations.string.StringProcessor.NoOpStringProcessor
O
- of(Method, String, Iterable<? extends SyntaxFragment>, String, Class<?>) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Construct a new immutable
CommandDescriptorinstance. - of(Method, String, List<SyntaxFragment>, String, Class<?>) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Construct a new immutable
CommandDescriptorinstance. - of(Parameter, String, String, String, DefaultValue<?, ?>, Description) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Construct a new immutable
ArgumentDescriptorinstance. - of(Parameter, String, Collection<String>, String, String, Permission, Description, boolean) - Static method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Construct a new immutable
FlagDescriptorinstance. - of(Parameter, Object) - Static method in interface org.incendo.cloud.annotations.method.ParameterValue
-
Creates a new parameter value.
- of(Parameter, Object, Descriptor) - Static method in interface org.incendo.cloud.annotations.method.ParameterValue
-
Creates a new parameter value.
- of(AnnotationParser<?>, ParameterNameExtractor, DescriptionMapper) - Static method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Construct a new immutable
StandardArgumentExtractorinstance. - OPTIONAL - Enum constant in enum org.incendo.cloud.annotations.ArgumentMode
- org.incendo.cloud.annotations - package org.incendo.cloud.annotations
-
Annotation parsing related classes
- org.incendo.cloud.annotations.assembler - package org.incendo.cloud.annotations.assembler
-
Assemblers that creates objects from descriptors.
- org.incendo.cloud.annotations.descriptor - package org.incendo.cloud.annotations.descriptor
-
Objects that describe different command components.
- org.incendo.cloud.annotations.exception - package org.incendo.cloud.annotations.exception
-
Classes related to
ExceptionHandler-annotated methods - org.incendo.cloud.annotations.extractor - package org.incendo.cloud.annotations.extractor
-
Extractors extract information and create descriptors.
- org.incendo.cloud.annotations.injection - package org.incendo.cloud.annotations.injection
-
Classes related to parameter injection
- org.incendo.cloud.annotations.method - package org.incendo.cloud.annotations.method
-
Utilities for working with annotated methods.
- org.incendo.cloud.annotations.parser - package org.incendo.cloud.annotations.parser
-
Classes related to
Parserannotated methods - org.incendo.cloud.annotations.processing - package org.incendo.cloud.annotations.processing
-
Annotation-processing related classes.
- org.incendo.cloud.annotations.string - package org.incendo.cloud.annotations.string
-
String processing utilities.
- org.incendo.cloud.annotations.suggestion - package org.incendo.cloud.annotations.suggestion
-
Classes related to
Suggestionsannotated methods
P
- parameter() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the parameter.
- parameter() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the parameter.
- parameter() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the parameter.
- parameter() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the parameter.
- parameter() - Method in interface org.incendo.cloud.annotations.method.ParameterValue
-
Returns the parameter.
- parameter(Parameter) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
parameterattribute. - parameter(Parameter) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
parameterattribute. - parameterNameExtractor() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Returns the
ParameterNameExtractorwhich is responsible for mapping parameters to syntax fragments in the case that a named @Argument annotation is not present. - parameterNameExtractor() - Method in class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
-
Returns the
ParameterNameExtractorwhich is responsible for mapping parameters to syntax fragments in the case that a named @Argument annotation is not present. - parameterNameExtractor(ParameterNameExtractor) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor.Builder
-
Initializes the value for the
parameterNameExtractorattribute. - ParameterNameExtractor - Interface in org.incendo.cloud.annotations.extractor
- parameters() - Method in class org.incendo.cloud.annotations.method.AnnotatedMethodHandler
-
Returns the method parameters.
- ParameterValue - Interface in org.incendo.cloud.annotations.method
- parse(Object...) - Method in class org.incendo.cloud.annotations.AnnotationParser
- parse(Collection<Object>) - Method in class org.incendo.cloud.annotations.AnnotationParser
- parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.annotations.parser.MethodArgumentParser
- parseContainers() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Parses all known
command containers. - parseContainers(ClassLoader) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Parses all known
command containers. - Parser - Annotation Type in org.incendo.cloud.annotations.parser
-
This annotation allows you to create annotated methods that behave like argument parsers.
- parserName() - Element in annotation type org.incendo.cloud.annotations.Argument
-
Name of the argument parser
- parserName() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the name of the parser to use.
- parserName() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the name of the parser to use.
- parserName() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the name of the parser to use.
- parserName() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the name of the parser to use.
- parserName() - Element in annotation type org.incendo.cloud.annotations.Flag
-
Name of the parser.
- parserName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
parserNameattribute. - parserName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
parserNameattribute. - parseSyntax(Method, String) - Method in interface org.incendo.cloud.annotations.SyntaxParser
-
Parses the given
stringintosyntax fragements. - parseSyntax(Method, String) - Method in class org.incendo.cloud.annotations.SyntaxParserImpl
- PATH - Static variable in class org.incendo.cloud.annotations.processing.CommandContainerProcessor
-
The file in which all command container names are stored.
- PatternReplacingStringProcessor - Class in org.incendo.cloud.annotations.string
-
StringProcessorthat replaces matches of a givenPattern. - PatternReplacingStringProcessor(Pattern, Function<MatchResult, String>) - Constructor for class org.incendo.cloud.annotations.string.PatternReplacingStringProcessor
-
Creates a new property replacing string processor.
- permission() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the permission of the flag.
- permission() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the permission of the flag.
- permission() - Element in annotation type org.incendo.cloud.annotations.Flag
-
The flag permission
- permission(Permission) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
permissionattribute. - Permission - Annotation Type in org.incendo.cloud.annotations
-
Equivalent to
Command.Builder.permission(String) - Permission.Mode - Enum in org.incendo.cloud.annotations
- PreprocessorMapper<A,
C> - Interface in org.incendo.cloud.annotations - preprocessorMappers() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns an unmodifiable view of the preprocessor mappers.
- priority() - Element in annotation type org.incendo.cloud.annotations.processing.CommandContainer
-
Returns the priority of the container.
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.incendo.cloud.annotations.processing.CommandContainerProcessor
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.incendo.cloud.annotations.processing.CommandMethodProcessor
- processString(String) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Processes the
inputstring and returns the processed result. - processString(String) - Method in class org.incendo.cloud.annotations.string.PatternReplacingStringProcessor
-
Processes the
inputstring and returns the processed result. - processString(String) - Method in class org.incendo.cloud.annotations.string.StringProcessor.NoOpStringProcessor
- processString(String) - Method in interface org.incendo.cloud.annotations.string.StringProcessor
-
Processes the
inputstring and returns the processed result. - processStrings(String[]) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Processes the input
stringsand returns the processed result. - processStrings(Collection<String>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Processes the input
stringsand returns the processed result. - PROPERTY_REGEX - Static variable in class org.incendo.cloud.annotations.string.PropertyReplacingStringProcessor
- PropertyReplacingStringProcessor - Class in org.incendo.cloud.annotations.string
-
PropertyReplacingStringProcessor.PropertyReplacementProviderthat replaces all sub-strings with the format${some.property}with a function-generated string. - PropertyReplacingStringProcessor(Function<String, String>) - Constructor for class org.incendo.cloud.annotations.string.PropertyReplacingStringProcessor
-
Creates a new property replacing string processor.
- ProxiedBy - Annotation Type in org.incendo.cloud.annotations
-
Creates a command proxy for the command.
R
- RawArgs - Annotation Type in org.incendo.cloud.annotations.injection
-
Used to inject
CommandContext.rawInput()into aCommand - Regex - Annotation Type in org.incendo.cloud.annotations
-
Annotation version of adding
RegexPreprocessoras a preprocessor usingCommandComponent.addPreprocessor(ComponentPreprocessor) - register(String, DefaultValueFactory<C, T>) - Method in interface org.incendo.cloud.annotations.DefaultValueRegistry
-
Registers the named default value.
- registerAnnotationMapper(Class<A>, AnnotationMapper<A>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Register an annotation mapper
- registerBuilderDecorator(BuilderDecorator<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Registers the given
decorator. - registerBuilderModifier(Class<A>, BuilderModifier<A, C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Register a builder modifier for a specific annotation.
- registerCommandExecutionMethodFactory(Predicate<Method>, CommandMethodExecutionHandlerFactory<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Registers a new command execution method factory.
- registerPreprocessorMapper(Class<A>, PreprocessorMapper<A, C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Registers a preprocessor mapper
- repeatable() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns whether the flag is repeatable.
- repeatable() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns whether the flag is repeatable.
- repeatable() - Element in annotation type org.incendo.cloud.annotations.Flag
-
Whether the flag can be repeated.
- repeatable(boolean) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
repeatableattribute. - REQUIRED - Enum constant in enum org.incendo.cloud.annotations.ArgumentMode
- requiredSender() - Element in annotation type org.incendo.cloud.annotations.Command
-
Returns the required sender type.
- requiredSender() - Method in interface org.incendo.cloud.annotations.descriptor.CommandDescriptor
-
Returns the required sender type.
- requiredSender() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Returns the required sender type.
- requiredSender(Class<?>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Initializes the value for the
requiredSenderattribute.
S
- simple() - Static method in interface org.incendo.cloud.annotations.DescriptionMapper
-
Returns a description mapper that maps the string to
Description.of(String). - simple() - Static method in interface org.incendo.cloud.annotations.extractor.ParameterNameExtractor
-
Returns a parameter name extractor that returns
Parameter.getName()without any transformations. - StandardArgumentExtractor - Class in org.incendo.cloud.annotations.extractor
- StandardArgumentExtractor() - Constructor for class org.incendo.cloud.annotations.extractor.StandardArgumentExtractor
- stringProcessor() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the string processor used by this parser.
- stringProcessor(StringProcessor) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Replaces the string processor of this parser.
- StringProcessor - Interface in org.incendo.cloud.annotations.string
-
Processor that intercepts all cloud annotation strings.
- StringProcessor.NoOpStringProcessor - Class in org.incendo.cloud.annotations.string
- suggestionProvider() - Method in class org.incendo.cloud.annotations.parser.MethodArgumentParser
- suggestionProviderFactory() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the suggestion provider factory.
- suggestionProviderFactory(SuggestionProviderFactory<C>) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the suggestion provider factory.
- SuggestionProviderFactory<C> - Interface in org.incendo.cloud.annotations.suggestion
- suggestions() - Element in annotation type org.incendo.cloud.annotations.Argument
-
Name of the suggestion provider to use.
- suggestions() - Method in interface org.incendo.cloud.annotations.descriptor.ArgumentDescriptor
-
Returns the name of the suggestion provider to use.
- suggestions() - Method in interface org.incendo.cloud.annotations.descriptor.FlagDescriptor
-
Returns the name of the suggestion provider to use.
- suggestions() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Returns the name of the suggestion provider to use.
- suggestions() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Returns the name of the suggestion provider to use.
- suggestions() - Element in annotation type org.incendo.cloud.annotations.Flag
-
Name of the suggestion provider to use.
- suggestions() - Element in annotation type org.incendo.cloud.annotations.parser.Parser
-
Returns the of the suggestion provider to use.
- suggestions(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder
-
Initializes the value for the
suggestionsattribute. - suggestions(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
-
Initializes the value for the
suggestionsattribute. - Suggestions - Annotation Type in org.incendo.cloud.annotations.suggestion
-
This annotation allows you to create annotated methods that behave like suggestion providers.
- suggestionsFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider
- syntax() - Method in interface org.incendo.cloud.annotations.descriptor.CommandDescriptor
-
Returns an unmodifiable view of the syntax fragments.
- syntax() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Returns an unmodifiable view of the syntax fragments.
- syntax(Iterable<? extends SyntaxFragment>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor.Builder
-
Sets or replaces all elements for
syntaxlist. - SyntaxFragment - Class in org.incendo.cloud.annotations
-
Represents the fragment of the syntax making up a command.
- SyntaxFragment(String, List<String>, ArgumentMode) - Constructor for class org.incendo.cloud.annotations.SyntaxFragment
-
Creates a new syntax fragment
- syntaxParser() - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Returns the syntax parser.
- syntaxParser(SyntaxParser) - Method in class org.incendo.cloud.annotations.AnnotationParser
-
Sets the syntax parser.
- SyntaxParser - Interface in org.incendo.cloud.annotations
-
Parser that produces
syntax fragmentsfrom command methods. - SyntaxParserImpl - Class in org.incendo.cloud.annotations
-
Parses command syntax into syntax fragments.
- SyntaxParserImpl() - Constructor for class org.incendo.cloud.annotations.SyntaxParserImpl
T
- toString() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Prints the immutable value
ArgumentDescriptorwith attribute values. - toString() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Prints the immutable value
CommandDescriptorwith attribute values. - toString() - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Prints the immutable value
FlagDescriptorwith attribute values. - toString() - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Prints the immutable value
StandardArgumentExtractorwith attribute values.
V
- value() - Element in annotation type org.incendo.cloud.annotations.Argument
-
The name of the argument that this parameter is bound to.
- value() - Element in annotation type org.incendo.cloud.annotations.Command
-
Returns the command syntax string.
- value() - Element in annotation type org.incendo.cloud.annotations.CommandDescription
-
Command description
- value() - Element in annotation type org.incendo.cloud.annotations.Commands
-
Returns the
comman methods. - value() - Element in annotation type org.incendo.cloud.annotations.Default
-
Returns the default value.
- value() - Element in annotation type org.incendo.cloud.annotations.exception.ExceptionHandler
-
Returns the type of exceptions caught by the exception handler.
- value() - Element in annotation type org.incendo.cloud.annotations.Flag
-
The flag name
- value() - Method in interface org.incendo.cloud.annotations.method.ParameterValue
-
Returns the parameter value.
- value() - Element in annotation type org.incendo.cloud.annotations.Permission
-
Returns the command permissions.
- value() - Element in annotation type org.incendo.cloud.annotations.ProxiedBy
-
Syntax of the proxying command
- value() - Element in annotation type org.incendo.cloud.annotations.Regex
-
Regular expression pattern
- value() - Element in annotation type org.incendo.cloud.annotations.suggestion.Suggestions
-
Returns the name of the suggestion provider.
- valueOf(String) - Static method in enum org.incendo.cloud.annotations.ArgumentMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.incendo.cloud.annotations.Permission.Mode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.incendo.cloud.annotations.ArgumentMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.incendo.cloud.annotations.Permission.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- withAliases(Collection<String>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
aliasesattribute. - withAnnotationParser(AnnotationParser<?>) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Copy the current immutable object by setting a value for the
annotationParserattribute. - withCommandToken(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object by setting a value for the
commandTokenattribute. - withDefaultValue(DefaultValue<?, ?>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
defaultValueattribute. - withDescription(Description) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
descriptionattribute. - withDescription(Description) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
descriptionattribute. - withDescriptionMapper(DescriptionMapper) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Copy the current immutable object by setting a value for the
descriptionMapperattribute. - withMethod(Method) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object by setting a value for the
methodattribute. - withName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
nameattribute. - withName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object by setting a value for the
nameattribute. - withName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
nameattribute. - withParameter(Parameter) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
parameterattribute. - withParameter(Parameter) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
parameterattribute. - withParameterNameExtractor(ParameterNameExtractor) - Method in class org.incendo.cloud.annotations.extractor.ImmutableStandardArgumentExtractor
-
Copy the current immutable object by setting a value for the
parameterNameExtractorattribute. - withParserName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
parserNameattribute. - withParserName(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
parserNameattribute. - withPermission(Permission) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
permissionattribute. - withRepeatable(boolean) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
repeatableattribute. - withRequiredSender(Class<?>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object by setting a value for the
requiredSenderattribute. - withSuggestions(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor
-
Copy the current immutable object by setting a value for the
suggestionsattribute. - withSuggestions(String) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor
-
Copy the current immutable object by setting a value for the
suggestionsattribute. - withSyntax(Iterable<? extends SyntaxFragment>) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object with elements that replace the content of
syntax. - withSyntax(SyntaxFragment...) - Method in class org.incendo.cloud.annotations.descriptor.ImmutableCommandDescriptor
-
Copy the current immutable object with elements that replace the content of
syntax. - withTransformation(Function<String, String>) - Static method in interface org.incendo.cloud.annotations.extractor.ParameterNameExtractor
-
Returns a parameter name extractor that transforms
Parameter.getName()using the giventransformation.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form