revxrsal.commands.autocomplete

Class SuggestionProviders<A extends CommandActor>

java.lang.Object

revxrsal.commands.autocomplete.SuggestionProviders<A>

Type Parameters:

A - The actor type

public final class SuggestionProviders<A extends CommandActor>
extends java.lang.Object

An immutable registry of SuggestionProviders and SuggestionProvider.Factories.

This type should be constructed using builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuggestionProviders.Builder<A extends CommandActor>

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull SuggestionProviders.Builder<A>	builder() Creates a new SuggestionProviders.Builder for SuggestionProviders.
@NotNull SuggestionProvider<A>	findNextProvider(@NotNull java.lang.reflect.Type type, @NotNull AnnotationList annotations, @NotNull SuggestionProvider.Factory<? super A> skipPast, @NotNull Lamp<A> lamp) Returns the first SuggestionProvider that comes after the skipPast factory.
@NotNull SuggestionProvider<A>	provider(@NotNull CommandParameter parameter, @NotNull Lamp<A> lamp) Returns the first SuggestionProvider that can create suggestions for the given parameter.
@NotNull SuggestionProvider<A>	provider(@NotNull java.lang.reflect.Type type, @NotNull AnnotationList annotations, @NotNull Lamp<A> lamp) Returns the first SuggestionProvider that can create suggestions for the given type and annotations.
@NotNull SuggestionProviders.Builder<A>	toBuilder() Creates a SuggestionProviders.Builder that contains the providers registered in this registry.

Methods inherited from class java.lang.Object

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

Method Detail

builder

@Contract(value="-> new",
          pure=true)
 @NotNull
public static <A extends CommandActor> @NotNull SuggestionProviders.Builder<A> builder()

Creates a new SuggestionProviders.Builder for SuggestionProviders.

Type Parameters:

A - The actor type

Returns:

The newly created SuggestionProviders.Builder.

provider

@NotNull
public @NotNull SuggestionProvider<A> provider(@NotNull
                                                        @NotNull CommandParameter parameter,
                                                        @NotNull
                                                        @NotNull Lamp<A> lamp)

Returns the first SuggestionProvider that can create suggestions for the given parameter.

Note that this method will never return null. In cases where no suitable provider is found, it will return SuggestionProvider.empty().

Parameters:

parameter - The parameter to create for

lamp - The Lamp instance to pass to factories

Returns:

The suggestion provider, or SuggestionProvider.empty().

provider

@NotNull
public @NotNull SuggestionProvider<A> provider(@NotNull
                                                        @NotNull java.lang.reflect.Type type,
                                                        @NotNull
                                                        @NotNull AnnotationList annotations,
                                                        @NotNull
                                                        @NotNull Lamp<A> lamp)

Returns the first SuggestionProvider that can create suggestions for the given type and annotations. This method can be used to create more complex suggestion providers for composite types (such as T[])

Note that this method will never return null. In cases where no suitable provider is found, it will return SuggestionProvider.empty().

Parameters:

type - The type to create for

annotations - The annotations to pass to factories

lamp - The Lamp instance to pass to factories

Returns:

The suggestion provider, or SuggestionProvider.empty().

findNextProvider

@NotNull
public @NotNull SuggestionProvider<A> findNextProvider(@NotNull
                                                                @NotNull java.lang.reflect.Type type,
                                                                @NotNull
                                                                @NotNull AnnotationList annotations,
                                                                @NotNull
                                                                @NotNull SuggestionProvider.Factory<? super A> skipPast,
                                                                @NotNull
                                                                @NotNull Lamp<A> lamp)

Returns the first SuggestionProvider that comes after the skipPast factory. This is useful for adding behavior on top of existing providers.

Parameters:

type - The type to create for

annotations - The annotations to pass to factories

skipPast - The factory to skip past. In most cases, this will be the caller factory, i.e. this.

lamp - The Lamp instance to pass to factories

Returns:

The suggestion provider, or SuggestionProvider.empty().

toBuilder

@Contract(value="-> new",
          pure=true)
 @NotNull
public @NotNull SuggestionProviders.Builder<A> toBuilder()

Creates a SuggestionProviders.Builder that contains the providers registered in this registry.

Returns:

The new builder