Package org.incendo.cloud.parser

Interface ParserRegistry<C>

Type Parameters:

C - command sender type

All Known Implementing Classes:

StandardParserRegistry

@API(status=STABLE)
public interface ParserRegistry<C>

Registry that allows parsers to be referenced by the type of the values they produce, or by their names.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ParserRegistry.AnnotationMapper<A extends Annotation>

Method Summary

Modifier and Type	Method	Description
<T> @NonNull Optional<ArgumentParser<C,T>>	createParser(@NonNull TypeToken<T> type, @NonNull ParserParameters parserParameters)	Attempts to create an instance of the default ArgumentParser for the given type using an instance of ParserParameter to configure the parser settings.
<T> @NonNull Optional<ArgumentParser<C,T>>	createParser(@NonNull String name, @NonNull ParserParameters parserParameters)	Attempts to create an instance of the parser ArgumentParser with the given name using an instance of ParserParameter to configure the parser settings.
@NonNull Optional<SuggestionProvider<C>>	getSuggestionProvider(@NonNull String name)	Returns a named suggestion provider, if it exists.
@NonNull ParserParameters	parseAnnotations(@NonNull TypeToken<?> parsingType, @NonNull Collection<? extends @NonNull Annotation> annotations)	Parses the given annotations into ParserParameters.
<A extends Annotation> ParserRegistry<C>	registerAnnotationMapper(@NonNull Class<A> annotation, @NonNull ParserRegistry.AnnotationMapper<A> mapper)	Registers a mapper that maps annotation instances to a map of parameter-object pairs.
default ParserRegistry<C>	registerNamedParser(@NonNull String name, @NonNull ParserDescriptor<C,?> descriptor)	Registers a named parser supplier.
ParserRegistry<C>	registerNamedParserSupplier(@NonNull String name, @NonNull Function<@NonNull ParserParameters,@NonNull ArgumentParser<C,?>> supplier)	Registers a named parser supplier.
default <T> ParserRegistry<C>	registerParser(@NonNull ParserDescriptor<C,T> descriptor)	Registers the parser described by the given descriptor.
<T> ParserRegistry<C>	registerParserSupplier(@NonNull TypeToken<T> type, @NonNull Function<@NonNull ParserParameters,@NonNull ArgumentParser<C,?>> supplier)	Registers the given supplier as the default parser supplier for the given type.
void	registerSuggestionProvider(@NonNull String name, @NonNull SuggestionProvider<C> suggestionProvider)	Registers a new named suggestion providers.

Method Details

registerParserSupplier

<T> ParserRegistry<C> registerParserSupplier(@NonNull TypeToken<T> type,
 @NonNull Function<@NonNull ParserParameters,@NonNull ArgumentParser<C,?>> supplier)

Registers the given supplier as the default parser supplier for the given type.

Type Parameters:

T - generic type specifying what is produced by the parser

Parameters:

type - type that is parsed by the parser

supplier - function that generates the parser

Returns:

this

registerParser

@API(status=STABLE)
default <T> ParserRegistry<C> registerParser(@NonNull ParserDescriptor<C,T> descriptor)

Registers the parser described by the given descriptor.

This does not allow for customization of the parser using parser parameters. If the parser has options then it is recommended to use registerParserSupplier(TypeToken, Function) instead.

Type Parameters:

T - type produced by the parser

Parameters:

descriptor - parser descriptor

Returns:

this

registerNamedParserSupplier

ParserRegistry<C> registerNamedParserSupplier(@NonNull String name,
 @NonNull Function<@NonNull ParserParameters,@NonNull ArgumentParser<C,?>> supplier)

Registers a named parser supplier.

The named parser will only be created if referenced by name using createParser(String, ParserParameters). Only unnamed parsers may be referenced by their value types.

Parameters:

name - parser name

supplier - the function that generates the parser

Returns:

this

registerNamedParser

default ParserRegistry<C> registerNamedParser(@NonNull String name,
 @NonNull ParserDescriptor<C,?> descriptor)

Registers a named parser supplier.

This does not allow for customization of the parser using parser parameters. If the parser has options then it is recommended to use registerNamedParserSupplier(String, Function) instead.

Parameters:

name - parser name

descriptor - parser descriptor

Returns:

this

registerAnnotationMapper

<A extends Annotation> ParserRegistry<C> registerAnnotationMapper(@NonNull Class<A> annotation,
 @NonNull ParserRegistry.AnnotationMapper<A> mapper)

Registers a mapper that maps annotation instances to a map of parameter-object pairs.

Type Parameters:

A - annotation type

Parameters:

annotation - annotation class

mapper - mapper that maps the pair (annotation, type to be parsed) to a map of parameter-object pairs

Returns:

this

parseAnnotations

@NonNull ParserParameters parseAnnotations(@NonNull TypeToken<?> parsingType,
 @NonNull Collection<? extends @NonNull Annotation> annotations)

Parses the given annotations into ParserParameters.

Parameters:

parsingType - the type that is produced by the parser that is requesting the parsing parameters

annotations - annotations to be parsed

Returns:

the parsed parameters

createParser

<T> @NonNull Optional<ArgumentParser<C,T>> createParser(@NonNull TypeToken<T> type,
 @NonNull ParserParameters parserParameters)

Attempts to create an instance of the default ArgumentParser for the given type using an instance of ParserParameter to configure the parser settings.

Type Parameters:

T - type of values produced by the parser

Parameters:

type - type of values produced by the parser

parserParameters - parser parameters

Returns:

the parser, if one could be created

createParser

<T> @NonNull Optional<ArgumentParser<C,T>> createParser(@NonNull String name,
 @NonNull ParserParameters parserParameters)

Attempts to create an instance of the parser ArgumentParser with the given name using an instance of ParserParameter to configure the parser settings.

Type Parameters:

T - type of values produced by the parser

Parameters:

name - name of the parser

parserParameters - parser parameters

Returns:

the parser, if one could be created

registerSuggestionProvider

@API(status=STABLE)
void registerSuggestionProvider(@NonNull String name,
 @NonNull SuggestionProvider<C> suggestionProvider)

Registers a new named suggestion providers.

Parameters:

name - name of the suggestion provider. The name is case independent.

suggestionProvider - the suggestion provider

See Also:

• Get a suggestion provider

getSuggestionProvider

@API(status=STABLE)
@NonNull Optional<SuggestionProvider<C>> getSuggestionProvider(@NonNull String name)

Returns a named suggestion provider, if it exists.

Parameters:

name - case-independent suggestion provider name

Returns:

optional that either contains the suggestion provider, or is empty if no suggestion provider is registered with the given name

See Also:

• Register a suggestion provider