Package cloud.commandframework.arguments.preprocessor

Class RegexPreprocessor<C>

java.lang.Object

cloud.commandframework.arguments.preprocessor.RegexPreprocessor<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

BiFunction<@NonNull CommandContext<C>,@NonNull Queue<@NonNull String>,@NonNull ArgumentParseResult<Boolean>>

@API(status=STABLE)
public final class RegexPreprocessor<C>
extends Object
implements BiFunction<@NonNull CommandContext<C>,@NonNull Queue<@NonNull String>,@NonNull ArgumentParseResult<Boolean>>

Command preprocessor that filters based on regular expressions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RegexPreprocessor.RegexValidationException	Exception thrown when input fails regex matching in RegexPreprocessor

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentParseResult<Boolean>	apply(@NonNull CommandContext<C> context, @NonNull Queue<@NonNull String> strings)
static <C> @NonNull RegexPreprocessor<C>	of(@NonNull String pattern)	Create a new preprocessor using StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX as the failure caption
static <C> @NonNull RegexPreprocessor<C>	of(@NonNull String pattern, @NonNull Caption failureCaption)	Create a new preprocessor

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Method Details

of

public static <C> @NonNull RegexPreprocessor<C> of(@NonNull String pattern)

Create a new preprocessor using StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX as the failure caption

Type Parameters:

C - Command sender type

Parameters:

pattern - Regular expression

Returns:

Preprocessor instance

of

public static <C> @NonNull RegexPreprocessor<C> of(@NonNull String pattern,
 @NonNull Caption failureCaption)

Create a new preprocessor

Type Parameters:

C - Command sender type

Parameters:

pattern - Regular expression

failureCaption - Caption sent when the input is invalid

Returns:

Preprocessor instance

apply

public @NonNull ArgumentParseResult<Boolean> apply(@NonNull CommandContext<C> context,
 @NonNull Queue<@NonNull String> strings)

Specified by:

apply in interface BiFunction<@NonNull CommandContext<C>,@NonNull Queue<@NonNull String>,@NonNull ArgumentParseResult<Boolean>>