Package cloud.commandframework.arguments.standard

Class ShortArgument.Builder<C>

java.lang.Object

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

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

Enclosing class:

ShortArgument<C>

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

Method Summary

Modifier and Type	Method	Description
@NonNull ShortArgument.Builder<C>	asOptionalWithDefault(short defaultValue)	Sets the command argument to be optional, with the specified default value.
@NonNull ShortArgument<C>	build()	Construct a command argument from the builder settings
@NonNull ShortArgument.Builder<C>	withMax(short max)	Set a maximum value
@NonNull ShortArgument.Builder<C>	withMin(short 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 ShortArgument.Builder<C> withMin(short min)

Set a minimum value

Parameters:

min - Minimum value

Returns:

Builder instance

withMax

public @NonNull ShortArgument.Builder<C> withMax(short max)

Set a maximum value

Parameters:

max - Maximum value

Returns:

Builder instance

asOptionalWithDefault

@API(status=STABLE,
     since="1.5.0")
public @NonNull ShortArgument.Builder<C> asOptionalWithDefault(short 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 ShortArgument<C> build()

Description copied from class: CommandArgument.Builder

Construct a command argument from the builder settings

Overrides:

build in class CommandArgument.Builder<C,Short>

Returns:

Constructed argument