Package org.incendo.cloud.parser.standard

Class BooleanParser<C>

java.lang.Object

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

All Implemented Interfaces:

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

@API(status=STABLE)
public final class BooleanParser<C>
extends Object
implements ArgumentParser<C,Boolean>, BlockingSuggestionProvider.Strings<C>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BooleanParser.BooleanParseException	Boolean parse exception

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>

Constructor Summary

Constructors

Constructor	Description
BooleanParser(boolean liberal)	Construct a new boolean parser

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CommandComponent.Builder<C,Boolean>	booleanComponent()	Returns a CommandComponent.Builder using booleanParser() as the parser.
static <C> @NonNull ParserDescriptor<C,Boolean>	booleanParser()	Creates a new boolean parser that only accepts true and false.
static <C> @NonNull ParserDescriptor<C,Boolean>	booleanParser(boolean liberal)	Creates a new boolean parser.
@NonNull ArgumentParseResult<Boolean>	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

Constructor Details

BooleanParser

public BooleanParser(boolean liberal)

Construct a new boolean parser

Parameters:

liberal - Whether it'll accept boolean-esque strings, or just booleans

Method Details

booleanParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,Boolean> booleanParser()

Creates a new boolean parser that only accepts true and false.

Type Parameters:

C - the command sender type

Returns:

the created parser

booleanParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,Boolean> booleanParser(boolean liberal)

Creates a new boolean parser. If liberal is true the parser only accepts true and false.

Type Parameters:

C - the command sender type

Parameters:

liberal - whether the parser should be liberal, see CommandInput.isValidBoolean(boolean)

Returns:

the created parser

booleanComponent

@API(status=STABLE)
public static <C>
@NonNull CommandComponent.Builder<C,Boolean> booleanComponent()

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

Type Parameters:

C - the command sender type

Returns:

the component builder

parse

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

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