Package org.incendo.cloud.parser.standard

Class LiteralParser<C>

java.lang.Object

org.incendo.cloud.parser.standard.LiteralParser<C>

All Implemented Interfaces:

ArgumentParser<C,String>, BlockingSuggestionProvider<C>, BlockingSuggestionProvider.Strings<C>, SuggestionProvider<C>, SuggestionProviderHolder<C>

public final class LiteralParser<C>
extends Object
implements ArgumentParser<C,String>, BlockingSuggestionProvider.Strings<C>

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.suggestion.BlockingSuggestionProvider

BlockingSuggestionProvider.Strings<C>

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<@NonNull String>	aliases()	Returns the aliases, if relevant.
@NonNull Collection<@NonNull String>	alternativeAliases()	Returns the aliases excluding the name, if relevant.
void	insertAlias(@NonNull String alias)	Insert a new alias
static <C> @NonNull ParserDescriptor<C,String>	literal(@NonNull String name, @NonNull String @NonNull ... aliases)	Creates a new literal parser that accepts the given name and aliases.
@NonNull ArgumentParseResult<String>	parse(@NonNull CommandContext<C> commandContext, @NonNull CommandInput commandInput)	Attempts to parse the input into an object of type ArgumentParser.
@NonNull Iterable<@NonNull String>	stringSuggestions(@NonNull CommandContext<C> commandContext, @NonNull CommandInput input)	Returns 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, parseFuture, suggestionProvider

Methods inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider

suggestionsFuture

Methods inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider.Strings

suggestions

Method Details

literal

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,String> literal(@NonNull String name,
 @NonNull String @NonNull ... aliases)

Creates a new literal parser that accepts the given name and aliases.

Type Parameters:

C - the command sender type

Parameters:

name - the literal name

aliases - the aliases

Returns:

the created parser

parse

public @NonNull ArgumentParseResult<String> parse(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput commandInput)

Description copied from interface: ArgumentParser

Attempts to parse the input into an object of type ArgumentParser.

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) 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:

parse in interface ArgumentParser<C,String>

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

Parsed command result

stringSuggestions

public @NonNull Iterable<@NonNull String> stringSuggestions(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput input)

Description copied from interface: BlockingSuggestionProvider.Strings

Returns 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.

Specified by:

stringSuggestions in interface BlockingSuggestionProvider.Strings<C>

Parameters:

commandContext - Command context

input - Input string

Returns:

List of suggestions

aliases

@API(status=STABLE)
public @NonNull Collection<@NonNull String> aliases()

Returns the aliases, if relevant.

Only literal components may have aliases. If this is a non-literal component then an empty collection is returned.

Returns:

unmodifiable view of the aliases

alternativeAliases

@API(status=STABLE)
public @NonNull Collection<@NonNull String> alternativeAliases()

Returns the aliases excluding the name, if relevant.

Only literal components may have aliases. If this is a non-literal component then an empty collection is returned.

Returns:

unmodifiable view of the aliases

insertAlias

public void insertAlias(@NonNull String alias)

Insert a new alias

Parameters:

alias - New alias