Package cloud.commandframework.arguments.standard

Class IntegerArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,Integer>

cloud.commandframework.arguments.standard.IntegerArgument<C>

All Implemented Interfaces:

CloudKeyHolder<Integer>, Comparable<CommandArgument<?,?>>

@API(status=STABLE)
public final class IntegerArgument<C>
extends CommandArgument<C,Integer>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IntegerArgument.Builder<C>
static final class	IntegerArgument.IntegerParseException
static final class	IntegerArgument.IntegerParser<C>

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull IntegerArgument.Builder<C>	builder(@NonNull String name)	Create a new IntegerArgument.Builder.
int	getMax()	Get the maximum accepted integer that could have been parsed
int	getMin()	Get the minimum accepted integer that could have been parsed
static <C> @NonNull IntegerArgument.Builder<C>	newBuilder(@NonNull String name)	Deprecated. prefer builder(String)
static <C> @NonNull CommandArgument<C,Integer>	of(@NonNull String name)	Create a new required IntegerArgument.
static <C> @NonNull CommandArgument<C,Integer>	optional(@NonNull String name)	Create a new optional IntegerArgument.
static <C> @NonNull CommandArgument<C,Integer>	optional(@NonNull String name, int defaultNum)	Create a new required IntegerArgument with the specified default value.

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

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

Method Details

builder

@API(status=STABLE,
     since="1.8.0")
public static <C>
@NonNull IntegerArgument.Builder<C> builder(@NonNull String name)

Create a new IntegerArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new IntegerArgument.Builder

Since:

1.8.0

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C>
@NonNull IntegerArgument.Builder<C> newBuilder(@NonNull String name)

Deprecated.

prefer builder(String)

Create a new builder

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

of

public static <C>
@NonNull CommandArgument<C,Integer> of(@NonNull String name)

Create a new required IntegerArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull CommandArgument<C,Integer> optional(@NonNull String name)

Create a new optional IntegerArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull CommandArgument<C,Integer> optional(@NonNull String name,
 int defaultNum)

Create a new required IntegerArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default value

Returns:

Created argument

getMin

public int getMin()

Get the minimum accepted integer that could have been parsed

Returns:

Minimum integer

getMax

public int getMax()

Get the maximum accepted integer that could have been parsed

Returns:

Maximum integer