Package net.minestom.server.command.builder.arguments.number

Class ArgumentNumber<T extends Number>

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<T>

net.minestom.server.command.builder.arguments.number.ArgumentNumber<T>

Direct Known Subclasses:

ArgumentDouble, ArgumentFloat, ArgumentInteger, ArgumentLong

public class ArgumentNumber<T extends Number>
extends Argument<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Comparator<T>	comparator
protected boolean	hasMax
protected boolean	hasMin
protected T	max
protected T	min
protected final NetworkBuffer.Type<T>	networkType
static final int	NOT_NUMBER_ERROR
protected final Function<String,T>	parser
protected final ArgumentParserType	parserName
protected final BiFunction<String,Integer,T>	radixParser
static final int	TOO_HIGH_ERROR
static final int	TOO_LOW_ERROR

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, suggestionType, useRemaining

Method Summary

Modifier and Type	Method	Description
@NotNull ArgumentNumber<T>	between(T min, T max)
T	getMax()	Gets the maximum value for this argument.
T	getMin()	Gets the minimum value for this argument.
byte	getNumberProperties()	Creates the byteflag based on the number's min/max existance.
protected int	getRadix(@NotNull String value)
boolean	hasMax()	Gets if the argument has a maximum.
boolean	hasMin()	Gets if the argument has a minimum.
@NotNull ArgumentNumber<T>	max(T value)
@NotNull ArgumentNumber<T>	min(T value)
byte @Nullable []	nodeProperties()
T	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
protected @NotNull String	parseValue(@NotNull String value)
protected @Nullable String	removeScientificNotation(@NotNull String value)

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, equals, filter, getCallback, getDefaultValue, getId, getSuggestionCallback, hasErrorCallback, hashCode, hasSuggestion, isOptional, map, map, parse, setCallback, setDefaultValue, setDefaultValue, setDefaultValue, setSuggestionCallback, suggestionType, useRemaining

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NOT_NUMBER_ERROR

public static final int NOT_NUMBER_ERROR

See Also:

• Constant Field Values

TOO_LOW_ERROR

public static final int TOO_LOW_ERROR

See Also:

• Constant Field Values

TOO_HIGH_ERROR

public static final int TOO_HIGH_ERROR

See Also:

• Constant Field Values

hasMin

protected boolean hasMin

hasMax

protected boolean hasMax

min

protected T extends Number min

max

protected T extends Number max

parserName

protected final ArgumentParserType parserName

radixParser

protected final BiFunction<String,Integer,T extends Number> radixParser

parser

protected final Function<String,T extends Number> parser

networkType

protected final NetworkBuffer.Type<T extends Number> networkType

comparator

protected final Comparator<T extends Number> comparator

Method Details

parse

@NotNull
public T parse(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String input)
        throws ArgumentSyntaxException

Description copied from class: Argument

Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T

Specified by:

parse in class Argument<T extends Number>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<T extends Number>

nodeProperties

public byte @Nullable [] nodeProperties()

Overrides:

nodeProperties in class Argument<T extends Number>

min

@NotNull
public @NotNull ArgumentNumber<T> min(@NotNull
 T value)

max

@NotNull
public @NotNull ArgumentNumber<T> max(@NotNull
 T value)

between

@NotNull
public @NotNull ArgumentNumber<T> between(@NotNull
 T min,
 @NotNull
 T max)

getNumberProperties

public byte getNumberProperties()

Creates the byteflag based on the number's min/max existance.

Returns:

A byteflag for argument specification.

hasMin

public boolean hasMin()

Gets if the argument has a minimum.

Returns:

true if the argument has a minimum

getMin

@NotNull
public T getMin()

Gets the minimum value for this argument.

Returns:

the minimum of this argument

hasMax

public boolean hasMax()

Gets if the argument has a maximum.

Returns:

true if the argument has a maximum

getMax

@NotNull
public T getMax()

Gets the maximum value for this argument.

Returns:

the maximum of this argument

parseValue

@NotNull
protected @NotNull String parseValue(@NotNull
 @NotNull String value)

getRadix

protected int getRadix(@NotNull
 @NotNull String value)

removeScientificNotation

@Nullable
protected @Nullable String removeScientificNotation(@NotNull
 @NotNull String value)