Package org.incendo.cloud.parser

Class MappedArgumentParserImpl<C,I,O>

java.lang.Object

org.incendo.cloud.parser.MappedArgumentParserImpl<C,I,O>

All Implemented Interfaces:

ArgumentParser<C,O>, ArgumentParser.FutureArgumentParser<C,O>, MappedArgumentParser<C,I,O>, SuggestionProviderHolder<C>

@API(status=INTERNAL)
public final class MappedArgumentParserImpl<C,I,O>
extends Object
implements MappedArgumentParser<C,I,O>, ArgumentParser.FutureArgumentParser<C,O>

Nested Class Summary

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

ArgumentParser.FutureArgumentParser<C,T>

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

MappedArgumentParser.Mapper<C,I,O>

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentParser<C,I>	baseParser()	Get the parser this one is derived from.
boolean	equals(@Nullable Object other)
<O1> @NonNull ArgumentParser.FutureArgumentParser<C,O1>	flatMap(MappedArgumentParser.Mapper<C,O,O1> mapper)	Create a derived argument parser preserving all properties of this parser, but converting the output type.
int	hashCode()
@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.
@NonNull SuggestionProvider<C>	suggestionProvider()	Returns the suggestion provider.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

flatMapSuccess, mapSuccess

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

parse

Method Details

baseParser

public @NonNull ArgumentParser<C,I> baseParser()

Description copied from interface: MappedArgumentParser

Get the parser this one is derived from.

Specified by:

baseParser in interface MappedArgumentParser<C,I,O>

Returns:

the base parser

parseFuture

public @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,I>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,I>

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

future that completes with the result.

suggestionProvider

public @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,I>

Specified by:

suggestionProvider in interface SuggestionProviderHolder<C>

Returns:

the suggestion provider

flatMap

public <O1>
@NonNull ArgumentParser.FutureArgumentParser<C,O1> flatMap(MappedArgumentParser.Mapper<C,O,O1> mapper)

Description copied from interface: ArgumentParser

Create a derived argument parser preserving all properties of this parser, but converting the output type.

Specified by:

flatMap in interface ArgumentParser<C,I>

Type Parameters:

O1 - the result type

Parameters:

mapper - the mapper to apply

Returns:

a derived parser.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object