Package io.github.mqzn.commands.arguments

Class ArgumentNumber<T extends Number>

java.lang.Object

io.github.mqzn.commands.arguments.AbstractArgument<T>

io.github.mqzn.commands.arguments.ArgumentNumber<T>

Type Parameters:

T - the type of the number

All Implemented Interfaces:

Argument<T>

Direct Known Subclasses:

ArgumentDouble, ArgumentFloat, ArgumentInteger, ArgumentLong

public abstract class ArgumentNumber<T extends Number>
extends AbstractArgument<T>

A class that represents any numeric argument

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 Function<String,T>	parser
protected final BiFunction<String,Integer,T>	radixParser

Fields inherited from class io.github.mqzn.commands.arguments.AbstractArgument

suggestions

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.
Function<String,T>	getParser()
protected int	getRadix(@NotNull String value)
boolean	hasMax()	Gets if the argument has a maximum.
boolean	hasMin()	Gets if the argument has a minimum.
abstract T	increment(T num)
@NotNull ArgumentNumber<T>	max(T value)
@NotNull ArgumentNumber<T>	min(T value)
T	parse(@NotNull String command, @NotNull String input)
protected @NotNull String	parseValue(@NotNull String value)
protected @Nullable String	removeScientificNotation(@NotNull String value)

Methods inherited from class io.github.mqzn.commands.arguments.AbstractArgument

asOptional, defaultValue, description, description, equals, hashCode, id, isOptional, setDefaultValue, setOptional, suggest, suggest, suggestions, toString, toString, type, useRemainingSpace

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mqzn.commands.arguments.Argument

alternativeTypes, isSuggestionDynamic

Field Details

radixParser

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

parser

protected final Function<String,T extends Number> parser

comparator

protected final Comparator<T extends Number> comparator

hasMin

protected boolean hasMin

hasMax

protected boolean hasMax

min

protected T extends Number min

max

protected T extends Number max

Method Details

parse

@NotNull
public T parse(@NotNull
 @NotNull String command,
 @NotNull
 @NotNull String input)
        throws ArgumentParseException

Throws:

ArgumentParseException

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)

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)

increment

public abstract T increment(T num)

getParser

public Function<String,T> getParser()