revxrsal.commands.autocomplete

Interface AutoCompleter<A extends CommandActor>

Type Parameters:

A - The actor type

public interface AutoCompleter<A extends CommandActor>

Represents an auto-completer that provides suggestions for the user input.

This should be accessed using Lamp.autoCompleter()

See Also:

SuggestionProvider, SuggestionProviders, SuggestionProviders.Builder, Lamp.Builder#suggestionProviders(), Suggest, SuggestWith

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<java.lang.String>	complete(A actor, @NotNull java.lang.String input) Returns a list of suggestions for the given input and actor.
@NotNull java.util.List<java.lang.String>	complete(A actor, @NotNull StringStream input) Returns a list of suggestions for the given input and actor.
static <A extends CommandActor> @NotNull AutoCompleter<A>	create(@NotNull Lamp<A> lamp) Creates an AutoCompleter for the given Lamp instance.

Method Detail

create

@ApiStatus.Internal
 @NotNull
static <A extends CommandActor> @NotNull AutoCompleter<A> create(@NotNull
                                                                                               @NotNull Lamp<A> lamp)

Creates an AutoCompleter for the given Lamp instance.

Type Parameters:

A - The actor type

Parameters:

lamp - Lamp instance to create for

Returns:

The AutoCompleter instance

complete

@NotNull
@NotNull java.util.List<java.lang.String> complete(@NotNull
                                                            A actor,
                                                            @NotNull
                                                            @NotNull java.lang.String input)

Returns a list of suggestions for the given input and actor.

This will exclude any command or parameter that the user has no access to.

If no suitable completions are found, this will return an empty, immutable list.

Parameters:

actor - The actor to supply for

input - The input to parse with

Returns:

The completions

complete

@NotNull
@NotNull java.util.List<java.lang.String> complete(@NotNull
                                                            A actor,
                                                            @NotNull
                                                            @NotNull StringStream input)

Returns a list of suggestions for the given input and actor.

This will exclude any command or parameter that the user has no access to.

If no suitable completions are found, this will return an empty, immutable list.

Parameters:

actor - The actor to supply for

input - The input to parse with

Returns:

The completions