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<?,
?>>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static final class
static final class
Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument
CommandArgument.TypedBuilder<C,
T, B extends CommandArgument.Builder<C, T>> -
Method Summary
Modifier and TypeMethodDescriptiondouble
getMax()
Get the maximum accepted double that could have been parseddouble
getMin()
Get the minimum accepted double that could have been parsedstatic <C> @NonNull DoubleArgument.Builder<C>
newBuilder
(@NonNull String name) Create a newDoubleArgument.Builder
.static <C> @NonNull CommandArgument<C,
Double> Create a new requiredDoubleArgument
.static <C> @NonNull CommandArgument<C,
Double> Create a new optionalDoubleArgument
.static <C> @NonNull CommandArgument<C,
Double> Create a new optionalDoubleArgument
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
-
Method Details
-
newBuilder
Create a newDoubleArgument.Builder
.- Type Parameters:
C
- Command sender type- Parameters:
name
- Name of the argument- Returns:
- Created builder
-
of
Create a new requiredDoubleArgument
.- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument name- Returns:
- Created argument
-
optional
Create a new optionalDoubleArgument
.- 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 optionalDoubleArgument
with the specified default value.- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument namedefaultNum
- 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
-