revxrsal.commands.autocomplete

Interface SuggestionProvider<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 SuggestionProvider<A extends CommandActor>
extends BaseSuggestionProvider

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SuggestionProvider.Factory<A extends CommandActor> Represents a factory that creates SuggestionProviders dynamically.

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull SuggestionProvider<A>	empty() Returns a SuggestionProvider that always gives empty suggestions.
static <A extends CommandActor> @NotNull SuggestionProvider<A>	fromAsync(@NotNull AsyncSuggestionProvider<A> provider) Creates a SuggestionProvider that provides suggestions asynchronously.
@NotNull java.util.Collection<java.lang.String>	getSuggestions(@NotNull ExecutionContext<A> context) Returns the suggestions
static <A extends CommandActor> @NotNull SuggestionProvider<A>	of(@NotNull java.util.List<java.lang.String> suggestions) Returns a SuggestionProvider that provides a static list of suggestions
static <A extends CommandActor> @NotNull SuggestionProvider<A>	of(java.lang.String... suggestions) Returns a SuggestionProvider that provides a static list of suggestions

Method Detail

empty

@NotNull
static <A extends CommandActor> @NotNull SuggestionProvider<A> empty()

Returns a SuggestionProvider that always gives empty suggestions.

Type Parameters:

A - The actor type

Returns:

The empty suggestion provider singleton

fromAsync

@Contract(value="_ -> new")
 @NotNull
static <A extends CommandActor> @NotNull SuggestionProvider<A> fromAsync(@NotNull
                                                                                                               @NotNull AsyncSuggestionProvider<A> provider)

Creates a SuggestionProvider that provides suggestions asynchronously.

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 AsyncSuggestionProvider.getSuggestionsAsync(ExecutionContext) will block.

Type Parameters:

A - The actor type

Parameters:

provider - The asynchronous provider

Returns:

The SuggestionProvider

of

@NotNull
static <A extends CommandActor> @NotNull SuggestionProvider<A> of(@NotNull
                                                                           java.lang.String... suggestions)

Returns a SuggestionProvider that provides a static list of suggestions

Type Parameters:

A - The actor type

Parameters:

suggestions - Suggestions to provide

Returns:

The suggestion provider.

of

@NotNull
static <A extends CommandActor> @NotNull SuggestionProvider<A> of(@NotNull
                                                                           @NotNull java.util.List<java.lang.String> suggestions)

Returns a SuggestionProvider that provides a static list of suggestions

Type Parameters:

A - The actor type

Parameters:

suggestions - Suggestions to provide

Returns:

The suggestion provider.

getSuggestions

@NotNull
@NotNull java.util.Collection<java.lang.String> getSuggestions(@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.