Class StringArrayArgument<C>
- java.lang.Object
-
- cloud.commandframework.arguments.CommandArgument<C,java.lang.String[]>
-
- cloud.commandframework.arguments.standard.StringArrayArgument<C>
-
- Type Parameters:
C
- Command sender type
- All Implemented Interfaces:
java.lang.Comparable<CommandArgument<?,?>>
public final class StringArrayArgument<C> extends CommandArgument<C,java.lang.String[]>
This is a command argument type that essentially mimicsStringArgument.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 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>
-
-
Method Summary
Modifier and Type Method Description static <C> @NonNull StringArrayArgument<C>
of(@NonNull java.lang.String name, @NonNull java.util.function.BiFunction<CommandContext<C>,java.lang.String,java.util.List<java.lang.String>> suggestionsProvider)
Create a new required string array argumentstatic <C> @NonNull StringArrayArgument<C>
optional(@NonNull java.lang.String name, @NonNull java.util.function.BiFunction<CommandContext<C>,java.lang.String,java.util.List<java.lang.String>> suggestionsProvider)
Create a new optional string array argument-
Methods inherited from class cloud.commandframework.arguments.CommandArgument
addPreprocessor, compareTo, copy, equals, getDefaultValue, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString
-
-
-
-
Method Detail
-
of
public static <C> @NonNull StringArrayArgument<C> of(@NonNull java.lang.String name, @NonNull java.util.function.BiFunction<CommandContext<C>,java.lang.String,java.util.List<java.lang.String>> suggestionsProvider)
Create a new required string array argument- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument namesuggestionsProvider
- Suggestions provider- Returns:
- Created argument
-
optional
public static <C> @NonNull StringArrayArgument<C> optional(@NonNull java.lang.String name, @NonNull java.util.function.BiFunction<CommandContext<C>,java.lang.String,java.util.List<java.lang.String>> suggestionsProvider)
Create a new optional string array argument- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument namesuggestionsProvider
- Suggestions provider- Returns:
- Created argument
-
-