revxrsal.commands.parameter

Class ParameterTypes.Builder<A extends CommandActor>

java.lang.Object

revxrsal.commands.parameter.ParameterTypes.Builder<A>

Enclosing class:

ParameterTypes<A extends CommandActor>

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
<T> ParameterTypes.Builder<A>	addContextParameter(@NotNull java.lang.Class<T> parameterClass, @NotNull ContextParameter<? super A,T> type) Registers a ParameterType that matches a specific class.
ParameterTypes.Builder<A>	addContextParameterFactory(ContextParameter.Factory<? super A> factory) Registers a ParameterType.Factory to this registry.
ParameterTypes.Builder<A>	addContextParameterFactoryLast(ContextParameter.Factory<? super A> factory) Registers a ParameterType.Factory to this registry.
<T> ParameterTypes.Builder<A>	addContextParameterLast(@NotNull java.lang.Class<T> parameterClass, @NotNull ContextParameter<? super A,T> contextParameter) Registers a ParameterType that matches a specific class.
<T> ParameterTypes.Builder<A>	addParameterType(@NotNull java.lang.Class<T> parameterClass, @NotNull ParameterType<? super A,T> type) Registers a ParameterType that matches a specific class.
ParameterTypes.Builder<A>	addParameterTypeFactory(ParameterType.Factory<? super A> factory) Registers a ParameterType.Factory to this registry.
ParameterTypes.Builder<A>	addParameterTypeFactoryLast(ParameterType.Factory<? super A> factory) Registers a ParameterType.Factory to this registry.
<T> ParameterTypes.Builder<A>	addParameterTypeLast(@NotNull java.lang.Class<T> parameterClass, @NotNull ParameterType<? super A,T> parameterType) Registers a ParameterType that matches a specific class.
@NotNull ParameterTypes<A>	build() Creates a new ParameterTypes 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

addParameterType

public <T> ParameterTypes.Builder<A> addParameterType(@NotNull
                                                      @NotNull java.lang.Class<T> parameterClass,
                                                      @NotNull
                                                      @NotNull ParameterType<? super A,T> type)

Registers a ParameterType 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 ParameterType.Factory.forTypeAndSubclasses(Class, ParameterType).

Parameters:

parameterClass - The type to register for

type - The parameter type

Returns:

This builder instance

addParameterTypeLast

public <T> ParameterTypes.Builder<A> addParameterTypeLast(@NotNull
                                                          @NotNull java.lang.Class<T> parameterClass,
                                                          @NotNull
                                                          @NotNull ParameterType<? super A,T> parameterType)

Registers a ParameterType 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 ParameterType.Factory.forTypeAndSubclasses(Class, ParameterType).

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

Parameters:

parameterClass - The type to register for

parameterType - The type to use

Returns:

This builder instance

addParameterTypeFactory

public ParameterTypes.Builder<A> addParameterTypeFactory(@NotNull
                                                         ParameterType.Factory<? super A> factory)

Registers a ParameterType.Factory to this registry.

Parameters:

factory - The factory to register

Returns:

This builder instance

addParameterTypeFactoryLast

public ParameterTypes.Builder<A> addParameterTypeFactoryLast(@NotNull
                                                             ParameterType.Factory<? super A> factory)

Registers a ParameterType.Factory to this registry.

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

Parameters:

factory - The factory to register

Returns:

This builder instance

addContextParameter

public <T> ParameterTypes.Builder<A> addContextParameter(@NotNull
                                                         @NotNull java.lang.Class<T> parameterClass,
                                                         @NotNull
                                                         @NotNull ContextParameter<? super A,T> type)

Registers a ParameterType 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 ParameterType.Factory.forTypeAndSubclasses(Class, ParameterType).

Parameters:

parameterClass - The type to register for

type - The parameter type

Returns:

This builder instance

addContextParameterLast

public <T> ParameterTypes.Builder<A> addContextParameterLast(@NotNull
                                                             @NotNull java.lang.Class<T> parameterClass,
                                                             @NotNull
                                                             @NotNull ContextParameter<? super A,T> contextParameter)

Registers a ParameterType 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 ParameterType.Factory.forTypeAndSubclasses(Class, ParameterType).

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

Parameters:

contextParameter - The context parameter type

parameterClass - The type to register for

Returns:

This builder instance

addContextParameterFactory

public ParameterTypes.Builder<A> addContextParameterFactory(@NotNull
                                                            ContextParameter.Factory<? super A> factory)

Registers a ParameterType.Factory to this registry.

Parameters:

factory - The factory to register

Returns:

This builder instance

addContextParameterFactoryLast

public ParameterTypes.Builder<A> addContextParameterFactoryLast(@NotNull
                                                                ContextParameter.Factory<? super A> factory)

Registers a ParameterType.Factory to this registry.

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

Parameters:

factory - The factory to register

Returns:

This builder instance

build

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

Creates a new ParameterTypes instance of this builder

Returns:

The newly created ParameterTypes registry.