Package org.incendo.cloud.parser.flag

Class CommandFlagParser<C>

java.lang.Object

org.incendo.cloud.parser.flag.CommandFlagParser<C>

All Implemented Interfaces:

ArgumentParser<C,Object>, ArgumentParser.FutureArgumentParser<C,Object>, SuggestionProvider<C>, SuggestionProviderHolder<C>

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
public final class CommandFlagParser<C>
extends Object
implements ArgumentParser.FutureArgumentParser<C,Object>, SuggestionProvider<C>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandFlagParser.FailureReason	Reasons for which flag parsing may fail
static final class	CommandFlagParser.FlagParseException	Flag parse exception

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

ArgumentParser.FutureArgumentParser<C,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final CloudKey<Integer>	FLAG_CURSOR_KEY	Metadata for the position of the cursor before parsing the last flag's value
static final CloudKey<String>	FLAG_META_KEY	Metadata for the last argument that was suggested
static final Object	FLAG_PARSE_RESULT_OBJECT	Dummy object that indicates that flags were parsed successfully
static final CloudKey<Set<CommandFlag<?>>>	PARSED_FLAGS	Metadata for the set of parsed flags, used to detect duplicates.

Constructor Summary

Constructors

Constructor	Description
CommandFlagParser(@NonNull Collection<@NonNull CommandFlag<?>> flags)	Creates a new command flag parser.

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<@NonNull CommandFlag<?>>	flags()	Returns the recognized flags.
@NonNull CompletableFuture<Optional<String>>	parseCurrentFlag(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput, @NonNull Executor completionExecutor)	Parses command input to figure out what flag is currently being typed at the end of the input queue.
@NonNull CompletableFuture<@NonNull ArgumentParseResult<Object>>	parseFuture(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)	Returns a future that completes with the result of parsing the given commandInput.
@NonNull CompletableFuture<Iterable<@NonNull Suggestion>>	suggestionsFuture(@NonNull CommandContext<C> commandContext, @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

Field Details

FLAG_PARSE_RESULT_OBJECT

public static final Object FLAG_PARSE_RESULT_OBJECT

Dummy object that indicates that flags were parsed successfully

FLAG_META_KEY

public static final CloudKey<String> FLAG_META_KEY

Metadata for the last argument that was suggested

FLAG_CURSOR_KEY

public static final CloudKey<Integer> FLAG_CURSOR_KEY

Metadata for the position of the cursor before parsing the last flag's value

PARSED_FLAGS

public static final CloudKey<Set<CommandFlag<?>>> PARSED_FLAGS

Metadata for the set of parsed flags, used to detect duplicates.

Constructor Details

CommandFlagParser

public CommandFlagParser(@NonNull Collection<@NonNull CommandFlag<?>> flags)

Creates a new command flag parser.

Parameters:

flags - the flags

Method Details

flags

@API(status=STABLE)
public @NonNull Collection<@NonNull CommandFlag<?>> flags()

Returns the recognized flags.

Returns:

unmodifiable view of flags

parseFuture

public @NonNull CompletableFuture<@NonNull ArgumentParseResult<Object>> 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,Object>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,Object>

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

future that completes with the result.

parseCurrentFlag

@API(status=STABLE)
public @NonNull CompletableFuture<Optional<String>> parseCurrentFlag(@NonNull CommandContext<@NonNull C> commandContext,
 @NonNull CommandInput commandInput,
 @NonNull Executor completionExecutor)

Parses command input to figure out what flag is currently being typed at the end of the input queue. If no flag value is being inputted, returns Optional.empty().

Will consume all but the last element from the input queue.

Parameters:

commandContext - Command context

commandInput - The input arguments

completionExecutor - The completion executor

Returns:

current flag being typed, or empty() if none is

suggestionsFuture

public @NonNull CompletableFuture<Iterable<@NonNull Suggestion>> suggestionsFuture(@NonNull CommandContext<C> commandContext,
 @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:

commandContext - the context of the suggestion lookup

input - the current input

Returns:

the suggestions