Package org.incendo.cloud.suggestion

Class DelegatingSuggestionFactory<C,S extends Suggestion>

java.lang.Object

org.incendo.cloud.suggestion.DelegatingSuggestionFactory<C,S>

Type Parameters:

C - command sender type

S - suggestion type

All Implemented Interfaces:

SuggestionFactory<C,S>

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

Command suggestion engine that delegates to a CommandTree

Constructor Summary

Constructors

Constructor	Description
DelegatingSuggestionFactory(@NonNull CommandManager<C> commandManager, @NonNull CommandTree<C> commandTree, @NonNull CommandContextFactory<C> contextFactory, @NonNull ExecutionCoordinator<C> executionCoordinator, @NonNull SuggestionMapper<S> mapper)	Creates a new DelegatingSuggestionFactory.

Method Summary

Modifier and Type	Method	Description
<S2 extends Suggestion> @NonNull SuggestionFactory<C,S2>	mapped(@NonNull SuggestionMapper<S2> mapper)	Returns a new suggestion factory that maps the results of this factory to the type SuggestionFactory using the given mapper.
@NonNull CompletableFuture<@NonNull Suggestions<C,S>>	suggest(@NonNull C sender, @NonNull String input)	Returns command suggestions for the "next" argument that would yield a correctly parsing command input
@NonNull CompletableFuture<@NonNull Suggestions<C,S>>	suggest(@NonNull CommandContext<C> context, @NonNull String input)	Returns command suggestions for the "next" argument that would yield a correctly parsing command input

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.suggestion.SuggestionFactory

suggestImmediately

Constructor Details

DelegatingSuggestionFactory

public DelegatingSuggestionFactory(@NonNull CommandManager<C> commandManager,
 @NonNull CommandTree<C> commandTree,
 @NonNull CommandContextFactory<C> contextFactory,
 @NonNull ExecutionCoordinator<C> executionCoordinator,
 @NonNull SuggestionMapper<S> mapper)

Creates a new DelegatingSuggestionFactory.

Parameters:

commandManager - the command manager

commandTree - the command tree

contextFactory - the context factory

executionCoordinator - the execution coordinator

mapper - the suggestion mapper

Method Details

suggest

public @NonNull CompletableFuture<@NonNull Suggestions<C,S>> suggest(@NonNull CommandContext<C> context,
 @NonNull String input)

Description copied from interface: SuggestionFactory

Returns command suggestions for the "next" argument that would yield a correctly parsing command input

Specified by:

suggest in interface SuggestionFactory<C,S extends Suggestion>

Parameters:

context - request context

input - input provided by the sender

Returns:

the suggestions

suggest

public @NonNull CompletableFuture<@NonNull Suggestions<C,S>> suggest(@NonNull C sender,
 @NonNull String input)

Description copied from interface: SuggestionFactory

Returns command suggestions for the "next" argument that would yield a correctly parsing command input

Specified by:

suggest in interface SuggestionFactory<C,S extends Suggestion>

Parameters:

sender - the sender

input - input provided by the sender

Returns:

the suggestions

mapped

public <S2 extends Suggestion>
@NonNull SuggestionFactory<C,S2> mapped(@NonNull SuggestionMapper<S2> mapper)

Description copied from interface: SuggestionFactory

Returns a new suggestion factory that maps the results of this factory to the type SuggestionFactory using the given mapper.

Specified by:

mapped in interface SuggestionFactory<C,S extends Suggestion>

Type Parameters:

S2 - the new suggestion type

Parameters:

mapper - the suggestion mapper

Returns:

the mapped factory