SuggestionProvider.Factory (common 4.0.0-beta.17 API)

Type Parameters:

A - The actor type

All Superinterfaces:

BaseSuggestionProvider

Enclosing interface:

SuggestionProvider<A extends CommandActor>
```
public static interface SuggestionProvider.Factory<A extends CommandActor>
extends BaseSuggestionProvider
```
Represents a factory that creates SuggestionProviders dynamically. This can access the parameter type, generics and annotations.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`@Nullable SuggestionProvider<A>`	`create(@NotNull java.lang.reflect.Type type, @NotNull AnnotationList annotations, @NotNull Lamp<A> lamp)` Creates a `SuggestionProvider` for the given parameter.
`static <A extends CommandActor,L extends java.lang.annotation.Annotation> SuggestionProvider.Factory<? super A>`	`forAnnotation(@NotNull java.lang.Class<L> annotationType, @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider)` Returns a `SuggestionProvider.Factory` that returns a suggestion provider for all parameters that contain a specific annotation
`static <A extends CommandActor> SuggestionProvider.Factory<? super A>`	`forType(@NotNull java.lang.Class<?> type, @NotNull SuggestionProvider<A> provider)` Returns a `SuggestionProvider.Factory` that returns a suggestion provider for all parameters that match a certain type.
`static <A extends CommandActor> SuggestionProvider.Factory<? super A>`	`forTypeAndSubclasses(@NotNull java.lang.Class<?> type, @NotNull SuggestionProvider<A> provider)` Returns a `SuggestionProvider.Factory` that returns a suggestion provider for all parameters that match a certain type, as well as its subclasses.

Method Detail

forType

static <A extends CommandActor> SuggestionProvider.Factory<? super A> forType(@NotNull
                                                                              @NotNull java.lang.Class<?> type,
                                                                              @NotNull
                                                                              @NotNull SuggestionProvider<A> provider)

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that match a certain type. Note that this does not include the subclasses of such type.

Type Parameters:: A - The actor type
Parameters:: type - Type to provide suggestions for; provider - The suggestion provider
Returns:: The newly created SuggestionProvider.Factory.

forTypeAndSubclasses

static <A extends CommandActor> SuggestionProvider.Factory<? super A> forTypeAndSubclasses(@NotNull
                                                                                           @NotNull java.lang.Class<?> type,
                                                                                           @NotNull
                                                                                           @NotNull SuggestionProvider<A> provider)

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that match a certain type, as well as its subclasses.

Type Parameters:: A - The actor type
Parameters:: type - Type to provide suggestions for; provider - The suggestion provider
Returns:: The newly created SuggestionProvider.Factory.

forAnnotation

@NotNull
static <A extends CommandActor,L extends java.lang.annotation.Annotation> SuggestionProvider.Factory<? super A> forAnnotation(@NotNull
                                                                                                                                       @NotNull java.lang.Class<L> annotationType,
                                                                                                                                       @NotNull
                                                                                                                                       @NotNull java.util.function.Function<L,SuggestionProvider<A>> provider)

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that contain a specific annotation

Type Parameters:: A - The actor type
Parameters:: annotationType - The annotation type to provide suggestions for; provider - The suggestion provider
Returns:: The newly created SuggestionProvider.Factory.

create

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

Creates a SuggestionProvider for the given parameter. If this parameter is not applicable, null should be returned.