Package org.incendo.cloud.parser.aggregate

Interface AggregateParser<C,O>

Type Parameters:

C - the command sender type

O - the output type

All Superinterfaces:

ArgumentParser<C,O>, ArgumentParser.FutureArgumentParser<C,O>, ParserDescriptor<C,O>, SuggestionProviderHolder<C>

@API(status=STABLE)
public interface AggregateParser<C,O>
extends ArgumentParser.FutureArgumentParser<C,O>, ParserDescriptor<C,O>

An argument parser that delegates to multiple inner components() and transforms the aggregate results into an output using the mapper().

You may either implement this interface to create a new parser type, or create an aggregate parser by using a builder().

The parsers components() will be invoked in the order of the returned collection. When parsing, each parser will be invoked and the result will be stored in a AggregateParsingContext. After parsing, the mapper() will be invoked, turning the intermediate results into the output type which is then returned by this parser.

When evaluating the suggestions for this parser, some component parsers will be invoked, which allows the suggestion providers to rely on the results from the preceding components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AggregateParser.AggregateParseException

Nested classes/interfaces inherited from interface org.incendo.cloud.parser.ArgumentParser

ArgumentParser.FutureArgumentParser<C,T>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull AggregateParserBuilder<C>	builder()	Returns a new aggregate command parser builder.
@NonNull List<@NonNull CommandComponent<C>>	components()	Returns the inner components of the parser.
@NonNull AggregateResultMapper<C,O>	mapper()	Returns the result mapper.
static <C, U, V> @NonNull AggregateParserPairBuilder<C,U,V,Pair<U,V>>	pairBuilder(@NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser)	Returns a new aggregate pair command parser builder.
default @NonNull CompletableFuture<@NonNull ArgumentParseResult<O>>	parseFuture(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)	Returns a future that completes with the result of parsing the given commandInput.
default @NonNull ArgumentParser<C,O>	parser()	Returns the parser.
default @NonNull SuggestionProvider<C>	suggestionProvider()	Returns the suggestion provider.
static <C, U, V, Z> @NonNull AggregateParserTripletBuilder<C,U,V,Z,Triplet<U,V,Z>>	tripletBuilder(@NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,Z> thirdParser)	Returns a new aggregate triplet command parser builder.

Methods inherited from interface org.incendo.cloud.parser.ArgumentParser

flatMap, flatMapSuccess, mapSuccess

Methods inherited from interface org.incendo.cloud.parser.ArgumentParser.FutureArgumentParser

parse

Methods inherited from interface org.incendo.cloud.parser.ParserDescriptor

flatMap, flatMap, flatMapSuccess, flatMapSuccess, mapSuccess, mapSuccess, valueType

Method Details

builder

static <C> @NonNull AggregateParserBuilder<C> builder()

Returns a new aggregate command parser builder. The builder is immutable, and each method returns a new builder instance.

Type Parameters:

C - the command sender type

Returns:

the builder

pairBuilder

static <C,
U,
V>
@NonNull AggregateParserPairBuilder<C,U,V,Pair<U,V>> pairBuilder(@NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser)

Returns a new aggregate pair command parser builder. The builder is immutable, and each method returns a new builder instance.

Type Parameters:

C - the command sender type

U - the type of the first component

V - the type of the second component

Parameters:

firstName - the name of the first component

firstParser - the parser for the first component

secondName - the name of the second component

secondParser - the parser for the second component

Returns:

the builder

tripletBuilder

static <C,
U,
V,
Z>
@NonNull AggregateParserTripletBuilder<C,U,V,Z,Triplet<U,V,Z>> tripletBuilder(@NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,Z> thirdParser)

Returns a new aggregate triplet command parser builder. The builder is immutable, and each method returns a new builder instance.

Type Parameters:

C - the command sender type

U - the type of the first component

V - the type of the second component

Z - the type of the third component

Parameters:

firstName - the name of the first component

firstParser - the parser for the first component

secondName - the name of the second component

secondParser - the parser for the second component

thirdName - the name of the third component

thirdParser - the parser for the third component

Returns:

the builder

components

@NonNull List<@NonNull CommandComponent<C>> components()

Returns the inner components of the parser.

Returns:

an unmodifiable view of the inner components in the order they were defined in

mapper

@NonNull AggregateResultMapper<C,O> mapper()

Returns the result mapper. It will be invoked after parsing to map the intermediate results into the output type.

Returns:

the result mapper

parseFuture

default @NonNull CompletableFuture<@NonNull ArgumentParseResult<O>> parseFuture(@NonNull CommandContext<@NonNull C> commandContext,
 @NonNull CommandInput commandInput)

Description copied from interface: ArgumentParser

Returns a future that completes with the result of parsing the given commandInput.

This method may be called when a command chain is being parsed for execution (using CommandExecutor.executeCommand(Object, String)) or when a command is being parsed to provide context for suggestions (using SuggestionFactory.suggest(Object, String)). It is possible to use CommandContext.isSuggestions()} to see what the purpose of the parsing is. Particular care should be taken when parsing for suggestions, as the parsing method is then likely to be called once for every character written by the command sender.

This method should never throw any exceptions under normal circumstances. Instead, if the parsing for some reason cannot be done successfully ArgumentParseResult.failure(Throwable) or ArgumentParseResult.failureFuture(Throwable) should be returned. This then wraps any exception that should be forwarded to the command sender.

The parser is assumed to be completely stateless and should not store any information about the command sender or the command context. Instead, information should be stored in the CommandContext.

Specified by:

parseFuture in interface ArgumentParser<C,O>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,O>

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

future that completes with the result.

suggestionProvider

default @NonNull SuggestionProvider<C> suggestionProvider()

Description copied from interface: ArgumentParser

Returns the suggestion provider.

By default, this will return the parser, if the parser is also a SuggestionProvider. Otherwise, SuggestionProvider.noSuggestions() will be returned.

Specified by:

suggestionProvider in interface ArgumentParser<C,O>

Specified by:

suggestionProvider in interface SuggestionProviderHolder<C>

Returns:

the suggestion provider

parser

default @NonNull ArgumentParser<C,O> parser()

Description copied from interface: ParserDescriptor

Returns the parser.

Specified by:

parser in interface ParserDescriptor<C,O>

Returns:

the parser