Package cloud.commandframework.arguments.standard

Class FloatArgument.Builder<C>

java.lang.Object

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

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

Enclosing class:

FloatArgument<C>

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

Method Summary

Modifier and Type	Method	Description
@NonNull FloatArgument.Builder<C>	asOptionalWithDefault(float defaultValue)	Sets the command argument to be optional, with the specified default value.
@NonNull FloatArgument<C>	build()	Construct a command argument from the builder settings
@NonNull FloatArgument.Builder<C>	withMax(int max)	Set a maximum value
@NonNull FloatArgument.Builder<C>	withMin(int min)	Set a minimum value

Methods inherited from class cloud.commandframework.arguments.CommandArgument.Builder

asOptional, asOptionalWithDefault, asRequired, getDefaultDescription, getDefaultValue, getName, getParser, getSuggestionsProvider, getValueType, isRequired, manager, withDefaultDescription, withParser, withSuggestionsProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withMin

public @NonNull FloatArgument.Builder<C> withMin(int min)

Set a minimum value

Parameters:

min - Minimum value

Returns:

Builder instance

withMax

public @NonNull FloatArgument.Builder<C> withMax(int max)

Set a maximum value

Parameters:

max - Maximum value

Returns:

Builder instance

asOptionalWithDefault

@API(status=STABLE,
     since="1.5.0")
public @NonNull FloatArgument.Builder<C> asOptionalWithDefault(float defaultValue)

Sets the command argument to be optional, with the specified default value.

Parameters:

defaultValue - default value

Returns:

this builder

Since:

1.5.0

See Also:

• CommandArgument.Builder.asOptionalWithDefault(String)

build

public @NonNull FloatArgument<C> build()

Description copied from class: CommandArgument.Builder

Construct a command argument from the builder settings

Overrides:

build in class CommandArgument.Builder<C,Float>

Returns:

Constructed argument