Package org.incendo.cloud.component.preprocessor

Interface ComponentPreprocessor<C>

All Known Implementing Classes:

RegexPreprocessor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@API(status=STABLE)
@FunctionalInterface
public interface ComponentPreprocessor<C>

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentParseResult<Boolean>	preprocess(@NonNull CommandContext<C> context, @NonNull CommandInput commandInput)	Pre-processes the associated component.
static <C> @NonNull ComponentPreprocessor<C>	wrap(@NonNull BiFunction<@NonNull CommandContext<C>,@NonNull CommandInput,@NonNull ArgumentParseResult<Boolean>> function)	Wraps the given function in a preprocessor.

Method Details

wrap

static <C> @NonNull ComponentPreprocessor<C> wrap(@NonNull BiFunction<@NonNull CommandContext<C>,@NonNull CommandInput,@NonNull ArgumentParseResult<Boolean>> function)

Wraps the given function in a preprocessor.

Type Parameters:

C - the command sender type

Parameters:

function - the function

Returns:

the wrapped function

preprocess

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

Pre-processes the associated component.

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

Parameters:

context - the command context

commandInput - the current command input

Returns:

the result