net.lenni0451.commandlib.types

Class IntegerType<E>

java.lang.Object

net.lenni0451.commandlib.types.IntegerType<E>

Type Parameters:

E - The type of the executor

All Implemented Interfaces:

ArgumentType<E,java.lang.Integer>

public class IntegerType<E>
extends java.lang.Object
implements ArgumentType<E,java.lang.Integer>

The integer type parses an integer number from the string reader.
Min and max values can be defined (inclusive).
Completions are calculated based on the min and max values.

Method Summary

Modifier and Type	Method and Description
int	getWeight()
static <E> IntegerType<E>	integer() Create a new integer type with no min and max value.
static <E> IntegerType<E>	integer(int min, int max) Create a new integer type with a min and max value.
static <E> IntegerType<E>	maxInteger(int max) Create a new integer type with a max value.
static <E> IntegerType<E>	minInteger(int min) Create a new integer type with a min value.
void	parseCompletions(java.util.Set<java.lang.String> completions, ExecutionContext<E> executionContext, StringReader stringReader) Provide the completions of this argument.
java.lang.Integer	parseValue(ExecutionContext<E> executionContext, StringReader stringReader) Parses the value of the argument.

Methods inherited from class java.lang.Object

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

Method Detail

integer

public static <E> IntegerType<E> integer()

Create a new integer type with no min and max value.
Values between Integer.MIN_VALUE and Integer.MAX_VALUE are allowed.

Type Parameters:

E - The type of the executor

Returns:

The new integer type

minInteger

public static <E> IntegerType<E> minInteger(int min)

Create a new integer type with a min value.
Values between min and Integer.MAX_VALUE are allowed.

Type Parameters:

E - The type of the executor

Parameters:

min - The min value

Returns:

The new integer type

maxInteger

public static <E> IntegerType<E> maxInteger(int max)

Create a new integer type with a max value.
Values between Integer.MIN_VALUE and max are allowed.

Type Parameters:

E - The type of the executor

Parameters:

max - The max value

Returns:

The new integer type

integer

public static <E> IntegerType<E> integer(int min,
                                         int max)

Create a new integer type with a min and max value.
Values between min and max are allowed.

Type Parameters:

E - The type of the executor

Parameters:

min - The min value

max - The max value

Returns:

The new integer type

getWeight

public int getWeight()

Specified by:

getWeight in interface ArgumentType<E,java.lang.Integer>

Returns:

The weight of this type. The higher the weight the more important it is.

parseValue

@Nonnull
public java.lang.Integer parseValue(ExecutionContext<E> executionContext,
                                              StringReader stringReader)
                                       throws ArgumentParseException,
                                              java.lang.RuntimeException

Description copied from interface: ArgumentType

Parses the value of the argument.

Specified by:

parseValue in interface ArgumentType<E,java.lang.Integer>

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

parseCompletions

public void parseCompletions(java.util.Set<java.lang.String> completions,
                             ExecutionContext<E> executionContext,
                             StringReader stringReader)

Description copied from interface: ArgumentType

Provide the completions of this argument.

Specified by:

parseCompletions in interface ArgumentType<E,java.lang.Integer>

Parameters:

completions - The set of completions

executionContext - The execution context

stringReader - The string reader