Package org.incendo.cloud.internal

Class SuggestionContext<C,S extends Suggestion>

java.lang.Object

org.incendo.cloud.internal.SuggestionContext<C,S>

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
public final class SuggestionContext<C,S extends Suggestion>
extends Object

Constructor Summary

Constructors

Constructor	Description
SuggestionContext(@NonNull SuggestionProcessor<C> processor, @NonNull CommandContext<C> commandContext, @NonNull CommandInput commandInput, @NonNull SuggestionMapper<S> mapper)	Creates a new suggestion context

Method Summary

Modifier and Type	Method	Description
void	addSuggestion(@NonNull Suggestion suggestion)	Adds the given suggestion to the stored suggestions
void	addSuggestions(@NonNull Iterable<? extends @NonNull Suggestion> suggestions)	Adds all the given suggestions to the stored suggestions
@NonNull CommandContext<C>	commandContext()	Returns the command context
@NonNull Suggestions<C,S>	makeSuggestions()	Create Suggestions from the current context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SuggestionContext

public SuggestionContext(@NonNull SuggestionProcessor<C> processor,
 @NonNull CommandContext<C> commandContext,
 @NonNull CommandInput commandInput,
 @NonNull SuggestionMapper<S> mapper)

Creates a new suggestion context

Parameters:

processor - the suggestion processor

commandContext - the command context

commandInput - the command input

mapper - the suggestion mapper

Method Details

makeSuggestions

public @NonNull Suggestions<C,S> makeSuggestions()

Create Suggestions from the current context.

Returns:

suggestions

commandContext

public @NonNull CommandContext<C> commandContext()

Returns the command context

Returns:

command context

addSuggestions

public void addSuggestions(@NonNull Iterable<? extends @NonNull Suggestion> suggestions)

Adds all the given suggestions to the stored suggestions

Parameters:

suggestions - the suggestions to add

addSuggestion

public void addSuggestion(@NonNull Suggestion suggestion)

Adds the given suggestion to the stored suggestions

Parameters:

suggestion - the suggestion to add