Package org.incendo.cloud.suggestion

Interface SuggestionProcessor<C>

Type Parameters:

C - command sender type

All Known Implementing Classes:

FilteringSuggestionProcessor

Functional Interface:

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

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

Processor that operates on the stream of suggestions before it is collected for the suggestion result passed to platform implementations or other callers.

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull SuggestionProcessor<C>	passThrough()	Creates a SuggestionProcessor that simply returns the input suggestions.
@NonNull Stream<@NonNull Suggestion>	process(@NonNull CommandPreprocessingContext<C> context, @NonNull Stream<@NonNull Suggestion> suggestions)	Adds operations to the suggestions stream and returns the result.
default @NonNull SuggestionProcessor<C>	then(@NonNull SuggestionProcessor<C> nextProcessor)	Create a chained processor that invokes this processor and then the nextProcessor with the result.

Method Details

passThrough

static <C> @NonNull SuggestionProcessor<C> passThrough()

Creates a SuggestionProcessor that simply returns the input suggestions.

Type Parameters:

C - command sender type

Returns:

the processor

process

@NonNull Stream<@NonNull Suggestion> process(@NonNull CommandPreprocessingContext<C> context,
 @NonNull Stream<@NonNull Suggestion> suggestions)

Adds operations to the suggestions stream and returns the result.

Parameters:

context - command preprocessing context which can be used to access the command context and command input

suggestions - the suggestions to process

Returns:

the processed suggestions

then

default @NonNull SuggestionProcessor<C> then(@NonNull SuggestionProcessor<C> nextProcessor)

Create a chained processor that invokes this processor and then the nextProcessor with the result.

Parameters:

nextProcessor - next suggestion processor

Returns:

chained processor