Package org.incendo.cloud.annotations

Class AnnotationParser<C>

java.lang.Object

org.incendo.cloud.annotations.AnnotationParser<C>

Type Parameters:

C - command sender type

public final class AnnotationParser<C>
extends Object

Parser that parses class instances commands

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INFERRED_ARGUMENT_NAME	The value of Argument that should be used to infer argument names from parameter names.

Constructor Summary

Constructors

Constructor	Description
AnnotationParser(@NonNull CommandManager<C> manager, @NonNull TypeToken<C> commandSenderClass)	Construct a new annotation parser
AnnotationParser(@NonNull CommandManager<C> manager, @NonNull TypeToken<C> commandSenderType, @NonNull Function<@NonNull ParserParameters,@NonNull CommandMeta> metaMapper)	Construct a new annotation parser
AnnotationParser(@NonNull CommandManager<C> manager, @NonNull Class<C> commandSenderClass)	Construct a new annotation parser
AnnotationParser(@NonNull CommandManager<C> manager, @NonNull Class<C> commandSenderClass, @NonNull Function<@NonNull ParserParameters,@NonNull CommandMeta> metaMapper)	Construct a new annotation parser

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentAssembler<C>	argumentAssembler()	Returns the argument assembler.
void	argumentAssembler(@NonNull ArgumentAssembler<C> argumentAssembler)	Sets the argument assembler
@NonNull ArgumentExtractor	argumentExtractor()	Returns the argument extractor.
void	argumentExtractor(@NonNull ArgumentExtractor argumentExtractor)	Sets the argument extractor.
@NonNull CommandExtractor	commandExtractor()	Returns the command extractor.
void	commandExtractor(@NonNull CommandExtractor commandExtractor)	Sets the command extractor.
@NonNull DefaultValueRegistry<C>	defaultValueRegistry()	Returns the default value registry.
void	defaultValueRegistry(@NonNull DefaultValueRegistry<C> defaultValueRegistry)	Sets the default value registry.
@NonNull DescriptionMapper	descriptionMapper()	Returns the description mapper.
void	descriptionMapper(@NonNull DescriptionMapper descriptionMapper)	Sets the description mapper.
@NonNull ExceptionHandlerFactory<C>	exceptionHandlerFactory()	Returns the exception provider factory.
void	exceptionHandlerFactory(@NonNull ExceptionHandlerFactory<C> exceptionHandlerFactory)	Sets the exception provider factory.
@NonNull FlagAssembler	flagAssembler()	Returns the flag assembler.
void	flagAssembler(@NonNull FlagAssembler flagAssembler)	Sets the flag assembler
@NonNull FlagExtractor	flagExtractor()	Returns the flag extractor.
void	flagExtractor(@NonNull FlagExtractor flagExtractor)	Sets the flag extractor.
@NonNull CommandManager<C>	manager()	Returns the command manager that was used to create this parser
@NonNull Description	mapDescription(@NonNull String string)	Maps the given string into a Description.
@NonNull MethodArgumentParserFactory<C>	methodArgumentParserFactory()	Returns the method argument parser factory.
void	methodArgumentParserFactory(@NonNull MethodArgumentParserFactory<C> methodArgumentParserFactory)	Sets the method argument parser factory.
@NonNull Collection<@NonNull Command<C>>	parse(@NonNull Object @NonNull ... instances)	Scan some instances of Command-annotated types and attempt to compile them into Command instances.
@NonNull Collection<@NonNull Command<C>>	parse(@NonNull Collection<@NonNull Object> instances)	Scan some instances of Command-annotated types and attempt to compile them into Command instances.
@NonNull Collection<@NonNull Command<C>>	parseContainers()	Parses all known command containers.
@NonNull Collection<@NonNull Command<C>>	parseContainers(@NonNull ClassLoader classLoader)	Parses all known command containers.
@NonNull Map<@NonNull Class<? extends Annotation>,@NonNull PreprocessorMapper<?,C>>	preprocessorMappers()	Returns an unmodifiable view of the preprocessor mappers.
@NonNull String	processString(@NonNull String input)	Processes the input string and returns the processed result.
@NonNull String[]	processStrings(@NonNull String[] strings)	Processes the input strings and returns the processed result.
@NonNull List<@NonNull String>	processStrings(@NonNull Collection<@NonNull String> strings)	Processes the input strings and returns the processed result.
<A extends Annotation> void	registerAnnotationMapper(@NonNull Class<A> annotation, @NonNull AnnotationMapper<A> mapper)	Register an annotation mapper
void	registerBuilderDecorator(@NonNull BuilderDecorator<C> decorator)	Registers the given decorator.
<A extends Annotation> void	registerBuilderModifier(@NonNull Class<A> annotation, @NonNull BuilderModifier<A,C> builderModifier)	Register a builder modifier for a specific annotation.
void	registerCommandExecutionMethodFactory(@NonNull Predicate<@NonNull Method> predicate, @NonNull CommandMethodExecutionHandlerFactory<C> factory)	Registers a new command execution method factory.
<A extends Annotation> void	registerPreprocessorMapper(@NonNull Class<A> annotation, @NonNull PreprocessorMapper<A,C> preprocessorMapper)	Registers a preprocessor mapper
@NonNull StringProcessor	stringProcessor()	Returns the string processor used by this parser.
void	stringProcessor(@NonNull StringProcessor stringProcessor)	Replaces the string processor of this parser.
@NonNull SuggestionProviderFactory<C>	suggestionProviderFactory()	Returns the suggestion provider factory.
void	suggestionProviderFactory(@NonNull SuggestionProviderFactory<C> suggestionProviderFactory)	Sets the suggestion provider factory.
@NonNull SyntaxParser	syntaxParser()	Returns the syntax parser.
void	syntaxParser(@NonNull SyntaxParser syntaxParser)	Sets the syntax parser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INFERRED_ARGUMENT_NAME

public static final String INFERRED_ARGUMENT_NAME

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

See Also:

• Constant Field Values

Constructor Details

AnnotationParser

public AnnotationParser(@NonNull CommandManager<C> manager,
 @NonNull Class<C> commandSenderClass,
 @NonNull Function<@NonNull ParserParameters,@NonNull CommandMeta> metaMapper)

Construct a new annotation parser

Parameters:

manager - Command manager instance

commandSenderClass - Command sender class

metaMapper - Function that is used to create CommandMeta instances from annotations on the command methods. These annotations will be mapped to ParserParameter. Mappers for the parser parameters can be registered using registerAnnotationMapper(Class, AnnotationMapper)

AnnotationParser

public AnnotationParser(@NonNull CommandManager<C> manager,
 @NonNull Class<C> commandSenderClass)

Construct a new annotation parser

Parameters:

manager - Command manager instance

commandSenderClass - Command sender class

AnnotationParser

public AnnotationParser(@NonNull CommandManager<C> manager,
 @NonNull TypeToken<C> commandSenderClass)

Construct a new annotation parser

Parameters:

manager - Command manager instance

commandSenderClass - Command sender class

AnnotationParser

@API(status=STABLE)
public AnnotationParser(@NonNull CommandManager<C> manager,
 @NonNull TypeToken<C> commandSenderType,
 @NonNull Function<@NonNull ParserParameters,@NonNull CommandMeta> metaMapper)

Construct a new annotation parser

Parameters:

manager - Command manager instance

commandSenderType - Command sender type

metaMapper - Function that is used to create CommandMeta instances from annotations on the command methods. These annotations will be mapped to ParserParameter. Mappers for the parser parameters can be registered using registerAnnotationMapper(Class, AnnotationMapper)

Method Details

manager

public @NonNull CommandManager<C> manager()

Returns the command manager that was used to create this parser

Returns:

Command manager

registerCommandExecutionMethodFactory

@API(status=STABLE)
public void registerCommandExecutionMethodFactory(@NonNull Predicate<@NonNull Method> predicate,
 @NonNull CommandMethodExecutionHandlerFactory<C> factory)

Registers a new command execution method factory. This allows for the registration of custom command method execution strategies.

Parameters:

predicate - the predicate that decides whether to apply the custom execution handler to the given method

factory - the function that produces the command execution handler

registerBuilderModifier

public <A extends Annotation> void registerBuilderModifier(@NonNull Class<A> annotation,
 @NonNull BuilderModifier<A,C> builderModifier)

Register a builder modifier for a specific annotation. The builder modifiers are allowed to act on a Command.Builder after all arguments have been added to the builder. This allows for modifications of the builder instance before the command is registered to the command manager.

Type Parameters:

A - Annotation type

Parameters:

annotation - Annotation (class) that the builder modifier reacts to

builderModifier - Modifier that acts on the given annotation and the incoming builder. Command builders are immutable, so the modifier should return the instance of the command builder that is returned as a result of any operation on the builder

registerBuilderDecorator

@API(status=STABLE)
public void registerBuilderDecorator(@NonNull BuilderDecorator<C> decorator)

Registers the given decorator.

The decorators are allowed to modify the command builders to set up default values. All other steps of the command construction process take priority over the decorators.

Parameters:

decorator - the decorator

registerAnnotationMapper

public <A extends Annotation> void registerAnnotationMapper(@NonNull Class<A> annotation,
 @NonNull AnnotationMapper<A> mapper)

Register an annotation mapper

Type Parameters:

A - Annotation type

Parameters:

annotation - Annotation class

mapper - Mapping function

registerPreprocessorMapper

@API(status=STABLE)
public <A extends Annotation> void registerPreprocessorMapper(@NonNull Class<A> annotation,
 @NonNull PreprocessorMapper<A,C> preprocessorMapper)

Registers a preprocessor mapper

Type Parameters:

A - annotation type

Parameters:

annotation - annotation class

preprocessorMapper - preprocessor mapper

preprocessorMappers

@API(status=STABLE)
public @NonNull Map<@NonNull Class<? extends Annotation>,@NonNull PreprocessorMapper<?,C>> preprocessorMappers()

Returns an unmodifiable view of the preprocessor mappers.

Returns:

the preprocessor mappers

stringProcessor

public @NonNull StringProcessor stringProcessor()

Returns the string processor used by this parser.

Returns:

the string processor

stringProcessor

public void stringProcessor(@NonNull StringProcessor stringProcessor)

Replaces the string processor of this parser.

Parameters:

stringProcessor - the new string processor

processString

public @NonNull String processString(@NonNull String input)

Processes the input string and returns the processed result.

Parameters:

input - the input string

Returns:

the processed string

processStrings

public @NonNull String[] processStrings(@NonNull String[] strings)

Processes the input strings and returns the processed result.

Parameters:

strings - the input strings

Returns:

the processed strings

processStrings

@API(status=STABLE)
public @NonNull List<@NonNull String> processStrings(@NonNull Collection<@NonNull String> strings)

Processes the input strings and returns the processed result.

Parameters:

strings - the input strings

Returns:

the processed strings

syntaxParser

public @NonNull SyntaxParser syntaxParser()

Returns the syntax parser.

Returns:

the syntax parser

syntaxParser

@API(status=STABLE)
public void syntaxParser(@NonNull SyntaxParser syntaxParser)

Sets the syntax parser.

Parameters:

syntaxParser - new syntax parser

argumentExtractor

@API(status=STABLE)
public @NonNull ArgumentExtractor argumentExtractor()

Returns the argument extractor.

Returns:

the argument extractor

argumentExtractor

@API(status=STABLE)
public void argumentExtractor(@NonNull ArgumentExtractor argumentExtractor)

Sets the argument extractor.

Parameters:

argumentExtractor - new argument extractor

argumentAssembler

@API(status=STABLE)
public @NonNull ArgumentAssembler<C> argumentAssembler()

Returns the argument assembler.

Returns:

the argument assembler

argumentAssembler

@API(status=STABLE)
public void argumentAssembler(@NonNull ArgumentAssembler<C> argumentAssembler)

Sets the argument assembler

Parameters:

argumentAssembler - new argument assembler

flagExtractor

@API(status=STABLE)
public @NonNull FlagExtractor flagExtractor()

Returns the flag extractor.

Returns:

the flag extractor

flagExtractor

@API(status=STABLE)
public void flagExtractor(@NonNull FlagExtractor flagExtractor)

Sets the flag extractor.

Parameters:

flagExtractor - new flag extractor

flagAssembler

@API(status=STABLE)
public @NonNull FlagAssembler flagAssembler()

Returns the flag assembler.

Returns:

the flag assembler

flagAssembler

@API(status=STABLE)
public void flagAssembler(@NonNull FlagAssembler flagAssembler)

Sets the flag assembler

Parameters:

flagAssembler - new flag assembler

commandExtractor

@API(status=STABLE)
public @NonNull CommandExtractor commandExtractor()

Returns the command extractor.

Returns:

the command extractor

commandExtractor

@API(status=STABLE)
public void commandExtractor(@NonNull CommandExtractor commandExtractor)

Sets the command extractor.

Parameters:

commandExtractor - new command extractor

suggestionProviderFactory

@API(status=STABLE)
public @NonNull SuggestionProviderFactory<C> suggestionProviderFactory()

Returns the suggestion provider factory.

Returns:

the suggestion provider factory

suggestionProviderFactory

@API(status=STABLE)
public void suggestionProviderFactory(@NonNull SuggestionProviderFactory<C> suggestionProviderFactory)

Sets the suggestion provider factory.

Parameters:

suggestionProviderFactory - new suggestion provider factory

methodArgumentParserFactory

@API(status=EXPERIMENTAL)
public @NonNull MethodArgumentParserFactory<C> methodArgumentParserFactory()

Returns the method argument parser factory.

Returns:

the method argument parser factory

methodArgumentParserFactory

@API(status=EXPERIMENTAL)
public void methodArgumentParserFactory(@NonNull MethodArgumentParserFactory<C> methodArgumentParserFactory)

Sets the method argument parser factory.

Parameters:

methodArgumentParserFactory - new method argument parser factory

exceptionHandlerFactory

@API(status=STABLE)
public @NonNull ExceptionHandlerFactory<C> exceptionHandlerFactory()

Returns the exception provider factory.

Returns:

the exception provider factory

exceptionHandlerFactory

@API(status=STABLE)
public void exceptionHandlerFactory(@NonNull ExceptionHandlerFactory<C> exceptionHandlerFactory)

Sets the exception provider factory.

Parameters:

exceptionHandlerFactory - new exception provider factory

descriptionMapper

@API(status=STABLE)
public @NonNull DescriptionMapper descriptionMapper()

Returns the description mapper.

Returns:

the description mapper

descriptionMapper

@API(status=STABLE)
public void descriptionMapper(@NonNull DescriptionMapper descriptionMapper)

Sets the description mapper.

Parameters:

descriptionMapper - new description mapper

defaultValueRegistry

public @NonNull DefaultValueRegistry<C> defaultValueRegistry()

Returns the default value registry.

Returns:

the default value registry

defaultValueRegistry

public void defaultValueRegistry(@NonNull DefaultValueRegistry<C> defaultValueRegistry)

Sets the default value registry.

Parameters:

defaultValueRegistry - default value registry

parseContainers

public @NonNull Collection<@NonNull Command<C>> parseContainers()
                                                         throws Exception

Parses all known command containers.

This will use the class loader of the current class to retrieve the stored information about the command containers.

Returns:

Collection of parsed commands

Throws:

Exception - re-throws all encountered exceptions.

See Also:

• CommandContainer for more information.

parseContainers

@API(status=STABLE)
public @NonNull Collection<@NonNull Command<C>> parseContainers(@NonNull ClassLoader classLoader)
                                                         throws Exception

Parses all known command containers.

Parameters:

classLoader - class loader to use to scan for CommandContainerProcessor.PATH

Returns:

Collection of parsed commands

Throws:

Exception - re-throws all encountered exceptions.

See Also:

• CommandContainer for more information.

parse

public @NonNull Collection<@NonNull Command<C>> parse(@NonNull Object @NonNull ... instances)

Scan some instances of Command-annotated types and attempt to compile them into Command instances.

Parameters:

instances - instances to scan

Returns:

collection of parsed commands

parse

public @NonNull Collection<@NonNull Command<C>> parse(@NonNull Collection<@NonNull Object> instances)

Scan some instances of Command-annotated types and attempt to compile them into Command instances.

Parameters:

instances - instances to scan

Returns:

collection of parsed commands

mapDescription

@API(status=INTERNAL,
     consumers="org.incendo.cloud.annotations.*")
public @NonNull Description mapDescription(@NonNull String string)

Maps the given string into a Description.

Parameters:

string - description literal

Returns:

the description