Package org.incendo.cloud.suggestion

Interface Suggestions<C,S extends Suggestion>

@Immutable
@API(status=STABLE)
public interface Suggestions<C,S extends Suggestion>

Method Summary

Modifier and Type	Method	Description
@NonNull CommandContext<C>	commandContext()	Returns the command context.
@NonNull CommandInput	commandInput()	Returns the CommandInput as seen by the last suggestion provider.
static <C, S extends Suggestion> Suggestions<C,S>	create(@NonNull CommandContext<C> ctx, @NonNull List<S> list, @NonNull CommandInput commandInput)	Create a Suggestions instance.
@NonNull List<S>	list()	Returns the list of suggestions.

Method Details

commandContext

@NonNull CommandContext<C> commandContext()

Returns the command context.

Returns:

the command context

list

@NonNull List<S> list()

Returns the list of suggestions.

Returns:

suggestion list

commandInput

@NonNull CommandInput commandInput()

Returns the CommandInput as seen by the last suggestion provider.

Returns:

command input

create

@API(status=INTERNAL)
static <C,
S extends Suggestion> Suggestions<C,S> create(@NonNull CommandContext<C> ctx,
 @NonNull List<S> list,
 @NonNull CommandInput commandInput)

Create a Suggestions instance.

Type Parameters:

C - command sender type

S - suggestion type

Parameters:

ctx - command context

list - suggestion list

commandInput - command input

Returns:

suggestions instance