Package cloud.commandframework.arguments.standard

Class StringArrayArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,String[]>

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

Type Parameters:

C - Command sender type

All Implemented Interfaces:

CloudKeyHolder<String[]>, Comparable<CommandArgument<?,?>>

@API(status=STABLE)
public final class StringArrayArgument<C>
extends CommandArgument<C,String[]>

This is a command argument type that essentially mimics StringArgument.greedy(String), but then splits the input string into a string array. The input string will be split at every blank space.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StringArrayArgument.StringArrayParser<C>	Parser that parses input into a string array

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

CommandArgument.Builder<C,T>, CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull StringArrayArgument<C>	of(@NonNull String name, boolean flagYielding, @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)	Create a new required string array argument
static <C> @NonNull StringArrayArgument<C>	of(@NonNull String name, @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)	Create a new required string array argument
static <C> @NonNull StringArrayArgument<C>	optional(@NonNull String name, boolean flagYielding, @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)	Create a new optional string array argument
static <C> @NonNull StringArrayArgument<C>	optional(@NonNull String name, @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)	Create a new optional string array argument

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

of

public static <C> @NonNull StringArrayArgument<C> of(@NonNull String name,
 @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)

Create a new required string array argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

suggestionsProvider - Suggestions provider

Returns:

Created argument

of

@API(status=STABLE,
     since="1.7.0")
public static <C> @NonNull StringArrayArgument<C> of(@NonNull String name,
 boolean flagYielding,
 @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)

Create a new required string array argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

flagYielding - Whether the parser should stop parsing when encountering a potential flag

suggestionsProvider - Suggestions provider

Returns:

Created argument

Since:

1.7.0

optional

public static <C> @NonNull StringArrayArgument<C> optional(@NonNull String name,
 @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)

Create a new optional string array argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

suggestionsProvider - Suggestions provider

Returns:

Created argument

optional

@API(status=STABLE,
     since="1.7.0")
public static <C> @NonNull StringArrayArgument<C> optional(@NonNull String name,
 boolean flagYielding,
 @NonNull BiFunction<CommandContext<C>,String,List<String>> suggestionsProvider)

Create a new optional string array argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

flagYielding - Whether the parser should stop parsing when encountering a potential flag

suggestionsProvider - Suggestions provider

Returns:

Created argument

Since:

1.7.0