Package org.incendo.cloud.parser.standard

Class StringArrayParser<C>

java.lang.Object

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

Type Parameters:

C - command sender type

All Implemented Interfaces:

ArgumentParser<C,String[]>, SuggestionProviderHolder<C>

@API(status=STABLE)
public final class StringArrayParser<C>
extends Object
implements ArgumentParser<C,String[]>

Parser that parses input into a string array

Nested Class Summary

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

ArgumentParser.FutureArgumentParser<C,T>

Constructor Summary

Constructors

Constructor	Description
StringArrayParser()	Construct a new string array parser.
StringArrayParser(boolean flagYielding)	Construct a new string array parser.

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CommandComponent.Builder<C,String[]>	characterComponent()	Returns a CommandComponent.Builder using stringArrayParser() as the parser.
static <C> @NonNull ParserDescriptor<C,String[]>	flagYieldingStringArrayParser()	Creates a new character parser that stops parsing when it encounters a command flag.
@NonNull ArgumentParseResult<String @NonNull []>	parse(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)	Attempts to parse the input into an object of type ArgumentParser.
static <C> @NonNull ParserDescriptor<C,String[]>	stringArrayParser()	Creates a new character parser.

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

Constructor Details

StringArrayParser

public StringArrayParser()

Construct a new string array parser.

StringArrayParser

@API(status=STABLE)
public StringArrayParser(boolean flagYielding)

Construct a new string array parser.

Parameters:

flagYielding - Whether the parser should stop parsing when encountering a potential flag

Method Details

stringArrayParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,String[]> stringArrayParser()

Creates a new character parser.

Type Parameters:

C - command sender type

Returns:

the created parser

flagYieldingStringArrayParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,String[]> flagYieldingStringArrayParser()

Creates a new character parser that stops parsing when it encounters a command flag.

Type Parameters:

C - command sender type

Returns:

the created parser

characterComponent

@API(status=STABLE)
public static <C>
@NonNull CommandComponent.Builder<C,String[]> characterComponent()

Returns a CommandComponent.Builder using stringArrayParser() as the parser.

Type Parameters:

C - the command sender type

Returns:

the component builder

parse

public @NonNull ArgumentParseResult<String @NonNull []> parse(@NonNull CommandContext<@NonNull 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