Package cloud.commandframework.arguments.standard

Class StringArgument.Builder<C>

java.lang.Object

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

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

Enclosing class:

StringArgument<C>

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

Method Summary

Modifier and Type	Method	Description
@NonNull StringArgument<C>	build()	Builder a new string argument
@NonNull StringArgument.Builder<C>	greedy()	Set the string mode to greedy
@NonNull StringArgument.Builder<C>	greedyFlagYielding()	Greedy string that will consume the input until a flag is present.
@NonNull StringArgument.Builder<C>	quoted()	Set the string mode to greedy
@NonNull StringArgument.Builder<C>	single()	Set the string mode to single
@NonNull StringArgument.Builder<C>	withSuggestionsProvider(@NonNull BiFunction<@NonNull CommandContext<C>,@NonNull String,@NonNull List<@NonNull String>> suggestionsProvider)	Set the suggestions provider

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

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

Methods inherited from class java.lang.Object

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

Method Details

greedy

public @NonNull StringArgument.Builder<C> greedy()

Set the string mode to greedy

Returns:

Builder instance

greedyFlagYielding

@API(status=STABLE,
     since="1.7.0")
public @NonNull StringArgument.Builder<C> greedyFlagYielding()

Greedy string that will consume the input until a flag is present.

Returns:

Builder instance

Since:

1.7.0

single

public @NonNull StringArgument.Builder<C> single()

Set the string mode to single

Returns:

Builder instance

quoted

public @NonNull StringArgument.Builder<C> quoted()

Set the string mode to greedy

Returns:

Builder instance

withSuggestionsProvider

public @NonNull StringArgument.Builder<C> withSuggestionsProvider(@NonNull BiFunction<@NonNull CommandContext<C>,@NonNull String,@NonNull List<@NonNull String>> suggestionsProvider)

Set the suggestions provider

Overrides:

withSuggestionsProvider in class CommandArgument.Builder<C,String>

Parameters:

suggestionsProvider - Suggestions provider

Returns:

Builder instance

build

public @NonNull StringArgument<C> build()

Builder a new string argument

Overrides:

build in class CommandArgument.Builder<C,String>

Returns:

Constructed argument