Package cloud.commandframework.arguments.standard

Class FloatArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Float>, Comparable<CommandArgument<?,?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FloatArgument.Builder<C>
static final class	FloatArgument.FloatParseException
static final class	FloatArgument.FloatParser<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
float	getMax()	Get the maximum accepted float that could have been parsed
float	getMin()	Get the minimum accepted float that could have been parsed
static <C> @NonNull FloatArgument.Builder<C>	newBuilder(@NonNull String name)	Create a new FloatArgument.Builder.
static <C> @NonNull CommandArgument<C,Float>	of(@NonNull String name)	Create a new required FloatArgument.
static <C> @NonNull CommandArgument<C,Float>	optional(@NonNull String name)	Create a new optional FloatArgument.
static <C> @NonNull CommandArgument<C,Float>	optional(@NonNull String name, float defaultNum)	Create a new optional FloatArgument 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

newBuilder

public static <C> @NonNull FloatArgument.Builder<C> newBuilder(@NonNull String name)

Create a new FloatArgument.Builder.

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

of

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

Create a new required FloatArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional FloatArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C> @NonNull CommandArgument<C,Float> optional(@NonNull String name,
 float defaultNum)

Create a new optional FloatArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default num

Returns:

Created argument

getMin

public float getMin()

Get the minimum accepted float that could have been parsed

Returns:

Minimum float

getMax

public float getMax()

Get the maximum accepted float that could have been parsed

Returns:

Maximum float