Package org.incendo.cloud.suggestion

Class FilteringSuggestionProcessor<C>

java.lang.Object

org.incendo.cloud.suggestion.FilteringSuggestionProcessor<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

SuggestionProcessor<C>

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

Command suggestion processor filters suggestions based on the remaining unconsumed input in the queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilteringSuggestionProcessor.Filter<C>	Filter function that tests (and potentially changes) each suggestion against the input and context.

Constructor Summary

Constructors

Constructor	Description
FilteringSuggestionProcessor()	Create a new FilteringSuggestionProcessor filtering with FilteringSuggestionProcessor.Filter.partialTokenMatches(boolean) that ignores case.
FilteringSuggestionProcessor(@NonNull FilteringSuggestionProcessor.Filter<C> filter)	Create a new FilteringSuggestionProcessor.

Method Summary

Modifier and Type	Method	Description
@NonNull Stream<@NonNull Suggestion>	process(@NonNull CommandPreprocessingContext<C> context, @NonNull Stream<@NonNull Suggestion> suggestions)	Adds operations to the suggestions stream and returns the result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.suggestion.SuggestionProcessor

then

Constructor Details

FilteringSuggestionProcessor

@API(status=STABLE)
public FilteringSuggestionProcessor()

Create a new FilteringSuggestionProcessor filtering with FilteringSuggestionProcessor.Filter.partialTokenMatches(boolean) that ignores case.

FilteringSuggestionProcessor

@API(status=STABLE)
public FilteringSuggestionProcessor(@NonNull FilteringSuggestionProcessor.Filter<C> filter)

Create a new FilteringSuggestionProcessor.

Parameters:

filter - mode

Method Details

process

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

Description copied from interface: SuggestionProcessor

Adds operations to the suggestions stream and returns the result.

Specified by:

process in interface SuggestionProcessor<C>

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