Package org.incendo.cloud.parser.standard

Class EitherParser<C,U,V>

java.lang.Object

org.incendo.cloud.parser.standard.EitherParser<C,U,V>

Type Parameters:

C - command sender type

U - primary value type

V - fallback value type

All Implemented Interfaces:

ArgumentParser<C,Either<U,V>>, ArgumentParser.FutureArgumentParser<C,Either<U,V>>, SuggestionProvider<C>, SuggestionProviderHolder<C>

@API(status=STABLE)
public final class EitherParser<C,U,V>
extends Object
implements ArgumentParser.FutureArgumentParser<C,Either<U,V>>, SuggestionProvider<C>

A parser which attempts to use the primary() parser and falls back on the fallback() parser if that fails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EitherParser.EitherParseException	Exception thrown when both the primary and fallback parsers fail to parse the input.

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

ArgumentParser.FutureArgumentParser<C,T>

Constructor Summary

Constructors

Constructor	Description
EitherParser(@NonNull ParserDescriptor<C,U> primary, @NonNull ParserDescriptor<C,V> fallback)	Creates a new either parser.

Method Summary

Modifier and Type	Method	Description
static <C, U, V> ParserDescriptor<C,Either<U,V>>	eitherParser(@NonNull ParserDescriptor<C,U> primary, @NonNull ParserDescriptor<C,V> fallback)	Creates a new parser which attempts to use the primary parser and falls back on the fallback parser if that fails.
@NonNull ParserDescriptor<C,V>	fallback()	Returns the fallback parser.
@NonNull CompletableFuture<@NonNull ArgumentParseResult<Either<U,V>>>	parseFuture(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)	Returns a future that completes with the result of parsing the given commandInput.
@NonNull ParserDescriptor<C,U>	primary()	Returns the primary parser.
@NonNull CompletableFuture<? extends @NonNull Iterable<? extends @NonNull Suggestion>>	suggestionsFuture(@NonNull CommandContext<C> context, @NonNull CommandInput input)	Returns a future that completes with the suggestions for the given input.

Methods inherited from class java.lang.Object

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

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

flatMap, flatMapSuccess, mapSuccess, suggestionProvider

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

parse

Constructor Details

EitherParser

public EitherParser(@NonNull ParserDescriptor<C,U> primary,
 @NonNull ParserDescriptor<C,V> fallback)

Creates a new either parser.

Parameters:

primary - primary parser

fallback - fallback parser which gets invoked if the primary parser fails to parse the input

Method Details

eitherParser

public static <C,
U,
V>
ParserDescriptor<C,Either<U,V>> eitherParser(@NonNull ParserDescriptor<C,U> primary,
 @NonNull ParserDescriptor<C,V> fallback)

Creates a new parser which attempts to use the primary parser and falls back on the fallback parser if that fails.

Type Parameters:

C - command sender type

U - primary value type

V - fallback value type

Parameters:

primary - primary parser

fallback - fallback parser which gets invoked if the primary parser fails to parse the input

Returns:

the descriptor of the parser

primary

public @NonNull ParserDescriptor<C,U> primary()

Returns the primary parser.

Returns:

the primary parser

fallback

public @NonNull ParserDescriptor<C,V> fallback()

Returns the fallback parser.

Returns:

the fallback parser

parseFuture

public @NonNull CompletableFuture<@NonNull ArgumentParseResult<Either<U,V>>> 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,U>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,U>

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

future that completes with the result.

suggestionsFuture

public @NonNull CompletableFuture<? extends @NonNull Iterable<? extends @NonNull Suggestion>> suggestionsFuture(@NonNull CommandContext<C> context,
 @NonNull CommandInput input)

Description copied from interface: SuggestionProvider

Returns a future that completes with the suggestions for the given input.

The input parameter contains all sender-provided input that has not yet been consumed by the argument parsers. If the component that the suggestion provider is generating suggestions for consumes multiple tokens the suggestion provider might receive a CommandInput instance containing multiple tokens. CommandInput.lastRemainingToken() may be used to extract the part of the command that is currently being completed by the command sender.

If you don't need to return a future, you can implement BlockingSuggestionProvider instead.

Specified by:

suggestionsFuture in interface SuggestionProvider<C>

Parameters:

context - the context of the suggestion lookup

input - the current input

Returns:

the suggestions