Package org.incendo.cloud.parser.standard

Class IntegerParser<C>

java.lang.Object

org.incendo.cloud.parser.standard.NumberParser<C,Integer,IntRange>

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

All Implemented Interfaces:

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

@API(status=STABLE)
public final class IntegerParser<C>
extends NumberParser<C,Integer,IntRange>
implements BlockingSuggestionProvider.Strings<C>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IntegerParser.IntegerParseException

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>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAXIMUM	Constant for the default/unset maximum value.
static final int	DEFAULT_MINIMUM	Constant for the default/unset minimum value.

Constructor Summary

Constructors

Constructor	Description
IntegerParser(int min, int max)	Construct a new integer parser

Method Summary

Modifier and Type	Method	Description
static @NonNull List<@NonNull String>	getSuggestions(@NonNull Range<? extends Number> range, @NonNull CommandInput input)	Returns integer suggestions.
boolean	hasMax()	Returns whether this parser has a maximum value set.
boolean	hasMin()	Returns whether this parser has a minimum value set.
static <C> @NonNull CommandComponent.Builder<C,Integer>	integerComponent()	Returns a CommandComponent.Builder using integerParser() as the parser.
static <C> @NonNull ParserDescriptor<C,Integer>	integerParser()	Creates a new integer parser using DEFAULT_MINIMUM and DEFAULT_MAXIMUM as the limits.
static <C> @NonNull ParserDescriptor<C,Integer>	integerParser(int minValue)	Creates a new integer parser using DEFAULT_MAXIMUM as the maximum value.
static <C> @NonNull ParserDescriptor<C,Integer>	integerParser(int minValue, int maxValue)	Creates a new integer parser.
@NonNull ArgumentParseResult<Integer>	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 org.incendo.cloud.parser.standard.NumberParser

range

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

Field Details

DEFAULT_MINIMUM

@API(status=STABLE)
public static final int DEFAULT_MINIMUM

Constant for the default/unset minimum value.

See Also:

• Constant Field Values

DEFAULT_MAXIMUM

@API(status=STABLE)
public static final int DEFAULT_MAXIMUM

Constant for the default/unset maximum value.

See Also:

• Constant Field Values

Constructor Details

IntegerParser

public IntegerParser(int min,
 int max)

Construct a new integer parser

Parameters:

min - Minimum acceptable value

max - Maximum acceptable value

Method Details

integerParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,Integer> integerParser()

Creates a new integer parser using DEFAULT_MINIMUM and DEFAULT_MAXIMUM as the limits.

Type Parameters:

C - the command sender type

Returns:

the created parser

integerParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,Integer> integerParser(int minValue)

Creates a new integer parser using DEFAULT_MAXIMUM as the maximum value.

Type Parameters:

C - the command sender type

Parameters:

minValue - the minimum value accepted by the parser

Returns:

the created parser

integerParser

@API(status=STABLE)
public static <C>
@NonNull ParserDescriptor<C,Integer> integerParser(int minValue,
 int maxValue)

Creates a new integer parser.

Type Parameters:

C - the command sender type

Parameters:

minValue - the minimum value accepted by the parser

maxValue - the maximum value accepted by the parser

Returns:

the created parser

integerComponent

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

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

Type Parameters:

C - the command sender type

Returns:

the component builder

getSuggestions

public static @NonNull List<@NonNull String> getSuggestions(@NonNull Range<? extends Number> range,
 @NonNull CommandInput input)

Returns integer suggestions. This supports both positive and negative numbers

Parameters:

range - accepted range

input - input

Returns:

list of suggestions

parse

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

Parameters:

commandContext - Command context

commandInput - Command Input

Returns:

Parsed command result

hasMax

public boolean hasMax()

Description copied from class: NumberParser

Returns whether this parser has a maximum value set.

In other words, whether the maximum of it's NumberParser.range() is different than the default maximum value.

Specified by:

hasMax in class NumberParser<C,Integer,IntRange>

Returns:

whether the parser has a maximum set

hasMin

public boolean hasMin()

Description copied from class: NumberParser

Returns whether this parser has a minimum value set.

In other words, whether the minimum of it's NumberParser.range() is different than the default minimum value.

Specified by:

hasMin in class NumberParser<C,Integer,IntRange>

Returns:

whether the parser has a minimum set

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