Package org.incendo.cloud.component.preprocessor

Class RegexPreprocessor<C>

java.lang.Object

org.incendo.cloud.component.preprocessor.RegexPreprocessor<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

ComponentPreprocessor<C>

@API(status=STABLE)
public final class RegexPreprocessor<C>
extends Object
implements ComponentPreprocessor<C>

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
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
@NonNull ArgumentParseResult<Boolean>	preprocess(@NonNull CommandContext<C> context, @NonNull CommandInput commandInput)	Pre-processes the associated component.

Methods inherited from class java.lang.Object

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

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

preprocess

public @NonNull ArgumentParseResult<Boolean> preprocess(@NonNull CommandContext<C> context,
 @NonNull CommandInput commandInput)

Description copied from interface: ComponentPreprocessor

Pre-processes the associated component.

If the preprocessor fails then the command parsing will fail immediately.

Specified by:

preprocess in interface ComponentPreprocessor<C>

Parameters:

context - the command context

commandInput - the current command input

Returns:

the result