Package revxrsal.commands.autocomplete

Interface SuggestionProvider

public interface SuggestionProvider

A provider for tab completions.

Register with AutoCompleter.registerSuggestion(String, SuggestionProvider)

Field Summary

Fields

Modifier and Type	Field	Description
static final SuggestionProvider	EMPTY	A SuggestionProvider that always returns an empty list.

Method Summary

Modifier and Type	Method	Description
default SuggestionProvider	compose(@Nullable SuggestionProvider other)	Composes the two SuggestionProviders into one provider that returns the completions from both.
@NotNull Collection<String>	getSuggestions(@NotNull List<String> args, @NotNull CommandActor sender, @NotNull ExecutableCommand command)	Returns the suggestions
static <T> SuggestionProvider	map(@NotNull Supplier<Collection<T>> values, Function<T,String> function)	Returns a SuggestionProvider that takes the given collection of values and maps it to strings according to the given function.
static SuggestionProvider	of(@NotNull Supplier<Collection<String>> supplier)	Returns a SuggestionProvider that computes the given supplier every time suggestions are returned.
static SuggestionProvider	of(@Nullable String... suggestions)	Returns a SuggestionProvider that always returns the given values
static SuggestionProvider	of(@Nullable Collection<String> suggestions)	Returns a SuggestionProvider that always returns the given values

Field Details

EMPTY

static final SuggestionProvider EMPTY

A SuggestionProvider that always returns an empty list.

Method Details

getSuggestions

@NotNull
@NotNull Collection<String> getSuggestions(@NotNull
 @NotNull List<String> args,
 @NotNull
 @NotNull CommandActor sender,
 @NotNull
 @NotNull ExecutableCommand command)
                                    throws Throwable

Returns the suggestions

Parameters:

args - The command arguments

sender - The command sender

command - The handled command

Returns:

The command suggestions.

Throws:

Throwable

compose

@Contract("null -> this; !null -> new")
default SuggestionProvider compose(@Nullable
 @Nullable SuggestionProvider other)

Composes the two SuggestionProviders into one provider that returns the completions from both.

Parameters:

other - Other provider to merge with

Returns:

The new provider

of

static SuggestionProvider of(@Nullable
 @Nullable Collection<String> suggestions)

Returns a SuggestionProvider that always returns the given values

Parameters:

suggestions - Values to return.

Returns:

The provider

of

static SuggestionProvider of(@Nullable
 @Nullable String... suggestions)

Returns a SuggestionProvider that always returns the given values

Parameters:

suggestions - Values to return.

Returns:

The provider

of

static SuggestionProvider of(@NotNull
 @NotNull Supplier<Collection<String>> supplier)

Returns a SuggestionProvider that computes the given supplier every time suggestions are returned.

Parameters:

supplier - The collection supplier

Returns:

The provider

map

static <T> SuggestionProvider map(@NotNull
 @NotNull Supplier<Collection<T>> values,
 Function<T,String> function)

Returns a SuggestionProvider that takes the given collection of values and maps it to strings according to the given function.

Type Parameters:

T - The values type

Parameters:

values - Values to map

function - Function to remap values with

Returns:

The provider