Package studio.mevera.imperat.providers

Interface SuggestionProvider<S extends CommandSource>

Type Parameters:

S - the command-sender valueType

@AvailableSince("1.0.0")
public interface SuggestionProvider<S extends CommandSource>

Represents a suggestion providing interface for an argument/parameter

See Also:

• Argument

Method Summary

Modifier and Type	Method	Description
static <S extends CommandSource> SuggestionProvider<S>	forCommand(Command<S> command)
List<String>	provide(SuggestionContext<S> context, Argument<S> argument)
default CompletableFuture<List<String>>	provideAsynchronously(SuggestionContext<S> context, Argument<S> parameter)
static <S extends CommandSource> SuggestionProvider<S>	staticSuggestions(String... results)
static <S extends CommandSource> SuggestionProvider<S>	staticSuggestions(List<String> results)

Method Details

staticSuggestions

static <S extends CommandSource>
SuggestionProvider<S> staticSuggestions(List<String> results)

staticSuggestions

static <S extends CommandSource>
SuggestionProvider<S> staticSuggestions(String... results)

forCommand

static <S extends CommandSource>
SuggestionProvider<S> forCommand(Command<S> command)

provide

List<String> provide(SuggestionContext<S> context,
 Argument<S> argument)

Parameters:

context - the context for suggestions

argument - the argument of the value to complete

Returns:

the auto-completed suggestions of the current argument

provideAsynchronously

default CompletableFuture<List<String>> provideAsynchronously(SuggestionContext<S> context,
 Argument<S> parameter)