Package org.incendo.cloud.annotations.suggestion

Class MethodSuggestionProvider<C>

java.lang.Object

org.incendo.cloud.annotations.method.AnnotatedMethodHandler<C>

org.incendo.cloud.annotations.suggestion.MethodSuggestionProvider<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

SuggestionProvider<C>

public final class MethodSuggestionProvider<C>
extends AnnotatedMethodHandler<C>
implements SuggestionProvider<C>

Represents a method annotated with Suggestions

Constructor Summary

Constructors

Constructor	Description
MethodSuggestionProvider(@NonNull Object instance, @NonNull Method method, @NonNull ParameterInjectorRegistry<C> injectorRegistry)	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
static @NonNull Iterable<@NonNull Suggestion>	mapCompleted(@NonNull Object input)	Maps the input to a list of suggestions.
static @NonNull CompletableFuture<Iterable<@NonNull Suggestion>>	mapFuture(@NonNull CompletableFuture future)	Maps the future to a future of suggestions.
static @NonNull CompletableFuture<Iterable<@NonNull Suggestion>>	mapSuggestions(@NonNull Object input)	Maps the suggestions to a future of a list of suggestions.
@NonNull CompletableFuture<Iterable<@NonNull Suggestion>>	suggestionsFuture(@NonNull CommandContext<C> context, @NonNull CommandInput input)

Methods inherited from class org.incendo.cloud.annotations.method.AnnotatedMethodHandler

annotationAccessor, createParameterValues, createParameterValues, createParameterValues, getInjectedValue, getParameterValue, injectorRegistry, methodHandle, parameters

Methods inherited from class java.lang.Object

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

Constructor Details

MethodSuggestionProvider

public MethodSuggestionProvider(@NonNull Object instance,
 @NonNull Method method,
 @NonNull ParameterInjectorRegistry<C> injectorRegistry)

Creates a new provider.

Parameters:

instance - instance that owns the method

method - the annotated method

injectorRegistry - injector registry

Method Details

suggestionsFuture

public @NonNull CompletableFuture<Iterable<@NonNull Suggestion>> suggestionsFuture(@NonNull CommandContext<C> context,
 @NonNull CommandInput input)

Specified by:

suggestionsFuture in interface SuggestionProvider<C>

mapSuggestions

public static @NonNull CompletableFuture<Iterable<@NonNull Suggestion>> mapSuggestions(@NonNull Object input)

Maps the suggestions to a future of a list of suggestions.

Parameters:

input - the input

Returns:

the mapped future

mapFuture

public static @NonNull CompletableFuture<Iterable<@NonNull Suggestion>> mapFuture(@NonNull CompletableFuture future)

Maps the future to a future of suggestions.

Parameters:

future - the future

Returns:

the mapped future

mapCompleted

public static @NonNull Iterable<@NonNull Suggestion> mapCompleted(@NonNull Object input)

Maps the input to a list of suggestions. The input must be a stream, or an iterable.

Parameters:

input - the input

Returns:

the suggestions