revxrsal.commands.parameter

Interface ContextParameter.Factory<A extends CommandActor>

Type Parameters:

A - The command actor type

All Superinterfaces:

ParameterFactory

All Known Implementing Classes:

ClassContextParameterFactory

Enclosing interface:

ContextParameter<A extends CommandActor,T>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ContextParameter.Factory<A extends CommandActor>
extends ParameterFactory

Represents a factory that constructs ContextParameters dynamically

Method Summary

Modifier and Type	Method and Description
<T> @Nullable ContextParameter<A,T>	create(@NotNull java.lang.reflect.Type parameterType, @NotNull AnnotationList annotations, @NotNull Lamp<A> lamp) Dynamically creates a ContextParameter
static <A extends CommandActor,T> @NotNull ContextParameter.Factory<A>	forType(@NotNull java.lang.Class<T> type, @NotNull ContextParameter<A,T> parameterType) Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that exactly have a certain class.
static <A extends CommandActor,T> @NotNull ContextParameter.Factory<A>	forTypeAndSubclasses(@NotNull java.lang.Class<T> type, @NotNull ContextParameter<A,T> parameterType) Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that are assignable from the given type.

Method Detail

forType

@NotNull
static <A extends CommandActor,T> @NotNull ContextParameter.Factory<A> forType(@NotNull
                                                                                        @NotNull java.lang.Class<T> type,
                                                                                        @NotNull
                                                                                        @NotNull ContextParameter<A,T> parameterType)

Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that exactly have a certain class.

Type Parameters:

A - The actor type

T - The parameter type

Parameters:

type - Parameter type to check against

parameterType - The parameter type to supply

Returns:

The parameter type factory

forTypeAndSubclasses

@NotNull
static <A extends CommandActor,T> @NotNull ContextParameter.Factory<A> forTypeAndSubclasses(@NotNull
                                                                                                     @NotNull java.lang.Class<T> type,
                                                                                                     @NotNull
                                                                                                     @NotNull ContextParameter<A,T> parameterType)

Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that are assignable from the given type.

Checking is done using Class.isAssignableFrom(Class).

Type Parameters:

A - The actor type

T - The parameter type

Parameters:

type - Parameter type to check against

parameterType - The parameter type to supply

Returns:

The parameter type factory

create

@Nullable
<T> @Nullable ContextParameter<A,T> create(@NotNull
                                                     @NotNull java.lang.reflect.Type parameterType,
                                                     @NotNull
                                                     @NotNull AnnotationList annotations,
                                                     @NotNull
                                                     @NotNull Lamp<A> lamp)

Dynamically creates a ContextParameter

Type Parameters:

T - The parameter type

Parameters:

parameterType - The command parameter to create for

annotations - The parameter annotations

lamp - The Lamp instance (for referencing other parameter types)

Returns:

The newly created ContextParameter, or null if this factory cannot deal with it.