revxrsal.commands.autocomplete

Interface AsyncSuggestionProvider<A extends CommandActor>

All Superinterfaces:

BaseSuggestionProvider

Functional Interface:

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

@FunctionalInterface
public interface AsyncSuggestionProvider<A extends CommandActor>
extends BaseSuggestionProvider

An interface that supplies completions asynchronously for the user depending on their input.

Note: The ability to provide asynchronous completions is platform-dependent. In platforms where such behavior is unsupported, Lamp will fall back to normal completions, and getSuggestionsAsync(ExecutionContext) will block.

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull AsyncSuggestionProvider<A>	from(@NotNull SuggestionProvider<A> provider) Creates a AsyncSuggestionProvider from the given SuggestionProvider
@NotNull java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>>	getSuggestionsAsync(@NotNull ExecutionContext<A> context) Returns the suggestions

Method Detail

from

@NotNull
static <A extends CommandActor> @NotNull AsyncSuggestionProvider<A> from(@NotNull
                                                                                  @NotNull SuggestionProvider<A> provider)

Creates a AsyncSuggestionProvider from the given SuggestionProvider

Type Parameters:

A - The actor type

Parameters:

provider - Provider to wrap

Returns:

The AsyncSuggestionProvider

getSuggestionsAsync

@NotNull
@NotNull java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>> getSuggestionsAsync(@NotNull
                                                                                                                     @NotNull ExecutionContext<A> context)

Returns the suggestions

Parameters:

context - The execution context. This will try to parse arguments inputted by the user and store them to provide context-aware suggestions.

Returns:

The command suggestions.