revxrsal.commands.autocomplete

Class SuggestionProviders.Builder<A extends CommandActor>

java.lang.Object

revxrsal.commands.autocomplete.SuggestionProviders.Builder<A>

Enclosing class:

SuggestionProviders<A extends CommandActor>

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
@NotNull SuggestionProviders.Builder<A>	addProvider(@NotNull java.lang.Class<?> type, @NotNull SuggestionProvider<A> provider) Registers a SuggestionProvider that matches a specific class.
SuggestionProviders.Builder<A>	addProviderFactory(SuggestionProvider.Factory<? super A> factory) Registers a SuggestionProvider.Factory to this registry.
SuggestionProviders.Builder<A>	addProviderFactoryLast(SuggestionProvider.Factory<? super A> factory) Registers a SuggestionProvider.Factory to this registry.
<L extends java.lang.annotation.Annotation> @NotNull SuggestionProviders.Builder<A>	addProviderForAnnotation(@NotNull java.lang.Class<L> type, @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider) Registers a SuggestionProvider that matches all parameters with a specific annotation.
<L extends java.lang.annotation.Annotation> @NotNull SuggestionProviders.Builder<A>	addProviderForAnnotationLast(@NotNull java.lang.Class<L> type, @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider) Registers a SuggestionProvider that matches all parameters with a specific annotation.
@NotNull SuggestionProviders.Builder<A>	addProviderLast(@NotNull java.lang.Class<?> type, @NotNull SuggestionProvider<A> provider) Registers a SuggestionProvider that matches a specific class.
@NotNull SuggestionProviders<A>	build() Creates a new SuggestionProviders instance of this builder

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addProvider

@NotNull
public @NotNull SuggestionProviders.Builder<A> addProvider(@NotNull
                                                                    @NotNull java.lang.Class<?> type,
                                                                    @NotNull
                                                                    @NotNull SuggestionProvider<A> provider)

Registers a SuggestionProvider that matches a specific class. Note that this will not include subclasses of such class.

If you would like to include subclasses, register the factory created by SuggestionProvider.Factory.forTypeAndSubclasses(Class, SuggestionProvider).

Parameters:

type - The type to register for

provider - The provider

Returns:

This builder instance

addProviderLast

@NotNull
public @NotNull SuggestionProviders.Builder<A> addProviderLast(@NotNull
                                                                        @NotNull java.lang.Class<?> type,
                                                                        @NotNull
                                                                        @NotNull SuggestionProvider<A> provider)

Registers a SuggestionProvider that matches a specific class. Note that this will not include subclasses of such class.

If you would like to include subclasses, register the factory created by SuggestionProvider.Factory.forTypeAndSubclasses(Class, SuggestionProvider).

Note that this will be given lower priority over other providers.

Parameters:

type - The type to register for

provider - The provider

Returns:

This builder instance

addProviderForAnnotation

@NotNull
public <L extends java.lang.annotation.Annotation> @NotNull SuggestionProviders.Builder<A> addProviderForAnnotation(@NotNull
                                                                                                                             @NotNull java.lang.Class<L> type,
                                                                                                                             @NotNull
                                                                                                                             @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider)

Registers a SuggestionProvider that matches all parameters with a specific annotation.

Parameters:

type - The type to register for

provider - The provider

Returns:

This builder instance

addProviderForAnnotationLast

@NotNull
public <L extends java.lang.annotation.Annotation> @NotNull SuggestionProviders.Builder<A> addProviderForAnnotationLast(@NotNull
                                                                                                                                 @NotNull java.lang.Class<L> type,
                                                                                                                                 @NotNull
                                                                                                                                 @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider)

Registers a SuggestionProvider that matches all parameters with a specific annotation.

Note that this will be given lower priority over other providers.

Parameters:

type - The type to register for

provider - The provider

Returns:

This builder instance

addProviderFactory

public SuggestionProviders.Builder<A> addProviderFactory(@NotNull
                                                         SuggestionProvider.Factory<? super A> factory)

Registers a SuggestionProvider.Factory to this registry.

Parameters:

factory - The factory to register

Returns:

This builder instance

addProviderFactoryLast

public SuggestionProviders.Builder<A> addProviderFactoryLast(@NotNull
                                                             SuggestionProvider.Factory<? super A> factory)

Registers a SuggestionProvider.Factory to this registry.

Note that this will be given lower priority over other providers.

Parameters:

factory - The factory to register

Returns:

This builder instance

build

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

Creates a new SuggestionProviders instance of this builder

Returns:

The newly created SuggestionProviders registry.