Package cloud.commandframework.arguments.standard

Class DoubleArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Double>, Comparable<CommandArgument<?,?>>

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

Nested Class Summary

Nested Classes

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

Create a new DoubleArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new DoubleArgument.Builder

Since:

1.8.0

newBuilder

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

Create a new required DoubleArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional DoubleArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull CommandArgument<C,Double> optional(@NonNull String name,
 double defaultNum)

Create a new optional DoubleArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default num

Returns:

Created argument

getMin

public double getMin()

Get the minimum accepted double that could have been parsed

Returns:

Minimum double

getMax

public double getMax()

Get the maximum accepted double that could have been parsed

Returns:

Maximum double