Package cloud.commandframework.arguments.standard

Class ShortArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Short>, Comparable<CommandArgument<?,?>>

@API(status=STABLE,
     since="1.5.0")
public final class ShortArgument<C>
extends CommandArgument<C,Short>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShortArgument.Builder<C>
static final class	ShortArgument.ShortParseException
static final class	ShortArgument.ShortParser<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 ShortArgument.Builder<C>	builder(@NonNull String name)	Create a new ShortArgument.Builder.
short	getMax()	Get the maximum accepted short that could have been parsed
short	getMin()	Get the minimum accepted short that could have been parsed
static <C> @NonNull ShortArgument.Builder<C>	newBuilder(@NonNull String name)	Deprecated. prefer builder(String)
static <C> @NonNull CommandArgument<C,Short>	of(@NonNull String name)	Create a new required ShortArgument.
static <C> @NonNull CommandArgument<C,Short>	optional(@NonNull String name)	Create a new optional ShortArgument.
static <C> @NonNull CommandArgument<C,Short>	optional(@NonNull String name, short defaultNum)	Create a new required ShortArgument 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 ShortArgument.Builder<C> builder(@NonNull String name)

Create a new ShortArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new ShortArgument.Builder

Since:

1.8.0

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C> @NonNull ShortArgument.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,Short> of(@NonNull String name)

Create a new required ShortArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional ShortArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C> @NonNull CommandArgument<C,Short> optional(@NonNull String name,
 short defaultNum)

Create a new required ShortArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default value

Returns:

Created argument

getMin

public short getMin()

Get the minimum accepted short that could have been parsed

Returns:

Minimum short

getMax

public short getMax()

Get the maximum accepted short that could have been parsed

Returns:

Maximum short