revxrsal.commands

Class Lamp.Builder<A extends CommandActor>

java.lang.Object

revxrsal.commands.Lamp.Builder<A>

Enclosing class:

Lamp<A extends CommandActor>

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
@NotNull Lamp.Builder<A>	accept(@NotNull LampBuilderVisitor<? super A> visitor) Accepts the given visitor by calling LampBuilderVisitor#visit(Builder) on this Lamp.Builder instance
<T extends java.lang.annotation.Annotation> Lamp.Builder<A>	annotationReplacer(@NotNull java.lang.Class<T> annotationType, @NotNull AnnotationReplacer<T> replacer) Registers an AnnotationReplacer for a specified annotation type
Lamp<A>	build() Constructs a Lamp from this Lamp.Builder.
Lamp.Builder<A>	commandCondition(@NotNull CommandCondition<? super A> condition) Registers a CommandCondition that is invoked before a command is finally executed
Lamp.Builder<A>	defaultErrorSender(@NotNull MessageSender<? super A,java.lang.String> messageSender) Registers the default message sender used by CommandActor.error(String)
Lamp.Builder<A>	defaultMessageSender(@NotNull MessageSender<? super A,java.lang.String> messageSender) Registers the default message sender used by CommandActor.reply(String)
<T> Lamp.Builder<A>	dependency(java.lang.Class<T> dependencyType, @NotNull java.util.function.Supplier<T> dependency) Registers the given dependency as a supplier that will provide the values as needed
<T> Lamp.Builder<A>	dependency(java.lang.Class<T> dependencyType, T dependency) Registers the given dependency as an object
DispatcherSettings.Builder<A>	dispatcherSettings() Returns the DispatcherSettings builder
@NotNull Lamp.Builder<A>	dispatcherSettings(@NotNull java.util.function.Consumer<DispatcherSettings.Builder<A>> consumer) Performs the given consumer on the dispatcherSettings() builder.
@NotNull Lamp.Builder<A>	dispatcherSettings(@NotNull DispatcherSettings<A> settings) Sets the DispatcherSettings that is used by this Lamp instance
Lamp.Builder<A>	exceptionHandler(@NotNull CommandExceptionHandler<A> handler) Sets the registered exception handler that handles all exceptions passed to this builder.
Hooks.Builder<A>	hooks() Returns the Hooks builder
@NotNull Lamp.Builder<A>	hooks(@NotNull java.util.function.Consumer<Hooks.Builder<A>> consumer) Performs the given consumer on the hooks() builder.
@NotNull Lamp.Builder<A>	parameterNamingStrategy(ParameterNamingStrategy namingStrategy) Sets the parameter naming strategy
ParameterTypes.Builder<A>	parameterTypes() Returns the ParameterTypes builder
@NotNull Lamp.Builder<A>	parameterTypes(@NotNull java.util.function.Consumer<ParameterTypes.Builder<A>> consumer) Performs the given consumer on the parameterTypes() builder.
<T> Lamp.Builder<A>	parameterValidator(java.lang.Class<T> type, @NotNull ParameterValidator<? super A,T> validator) Registers a ParameterValidator which validates certain types of parameters that get resolved by ParameterTypes
Lamp.Builder<A>	permissionFactory(CommandPermission.Factory<? super A> factory) Registers a CommandPermission.Factory that creates CommandPermissions for commands and parameters
<T extends java.lang.annotation.Annotation> Lamp.Builder<A>	permissionForAnnotation(@NotNull java.lang.Class<T> annotationType, @NotNull java.util.function.Function<T,CommandPermission<A>> permissionCreator) Registers a CommandPermission function that creates CommandPermissions for commands and parameters that have the given
<T> Lamp.Builder<A>	responseHandler(java.lang.Class<T> type, @NotNull ResponseHandler<? super A,T> responseHandler) Registers a ResponseHandler that accepts the objects matching a certain type returned by command functions.
Lamp.Builder<A>	responseHandler(ResponseHandler.Factory<? super A> responseHandler) Registers a ResponseHandler.Factory that accepts returned by command functions.
Lamp.Builder<A>	senderResolver(@NotNull SenderResolver<? super A> resolver) Registers a SenderResolver which is responsible for parsing the first parameter in the command and testing if it should be assumed the sender type
SuggestionProviders.Builder<A>	suggestionProviders() Returns the SuggestionProviders builder
@NotNull Lamp.Builder<A>	suggestionProviders(@NotNull java.util.function.Consumer<SuggestionProviders.Builder<A>> consumer) Performs the given consumer on the suggestionProviders() 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

parameterNamingStrategy

@NotNull
public @NotNull Lamp.Builder<A> parameterNamingStrategy(ParameterNamingStrategy namingStrategy)

Sets the parameter naming strategy

Parameters:

namingStrategy - The parameter naming strategy

Returns:

This builder instance

See Also:

ParameterNamingStrategy

parameterTypes

@NotNull
public ParameterTypes.Builder<A> parameterTypes()

Returns the ParameterTypes builder

Returns:

The parameter types builder

See Also:

ParameterTypes

parameterTypes

@NotNull
public @NotNull Lamp.Builder<A> parameterTypes(@NotNull
                                                        @NotNull java.util.function.Consumer<ParameterTypes.Builder<A>> consumer)

Performs the given consumer on the parameterTypes() builder. This allows for easier chaining of the Lamp.Builder instance

Parameters:

consumer - The consumer to perform

Returns:

This builder instance

See Also:

ParameterTypes

suggestionProviders

@NotNull
public SuggestionProviders.Builder<A> suggestionProviders()

Returns the SuggestionProviders builder

Returns:

The suggestion providers builder

See Also:

SuggestionProviders

suggestionProviders

@NotNull
public @NotNull Lamp.Builder<A> suggestionProviders(@NotNull
                                                             @NotNull java.util.function.Consumer<SuggestionProviders.Builder<A>> consumer)

Performs the given consumer on the suggestionProviders() builder. This allows for easier chaining of the Lamp.Builder instance

Parameters:

consumer - The consumer to perform

Returns:

This builder instance

See Also:

SuggestionProviders

dispatcherSettings

@NotNull
public @NotNull Lamp.Builder<A> dispatcherSettings(@NotNull
                                                            @NotNull java.util.function.Consumer<DispatcherSettings.Builder<A>> consumer)

Performs the given consumer on the dispatcherSettings() builder. This allows for easier chaining of the Lamp.Builder instance

Parameters:

consumer - The consumer to perform

Returns:

This builder instance

See Also:

DispatcherSettings

dispatcherSettings

@NotNull
public DispatcherSettings.Builder<A> dispatcherSettings()

Returns the DispatcherSettings builder

Returns:

The dispatcher settings builder

See Also:

DispatcherSettings

dispatcherSettings

@NotNull
public @NotNull Lamp.Builder<A> dispatcherSettings(@NotNull
                                                            @NotNull DispatcherSettings<A> settings)

Sets the DispatcherSettings that is used by this Lamp instance

Parameters:

settings - The settings to set

Returns:

This builder

See Also:

DispatcherSettings

hooks

@NotNull
public Hooks.Builder<A> hooks()

Returns the Hooks builder

Returns:

The hooks builder

See Also:

Hooks

hooks

@NotNull
public @NotNull Lamp.Builder<A> hooks(@NotNull
                                               @NotNull java.util.function.Consumer<Hooks.Builder<A>> consumer)

Performs the given consumer on the hooks() builder. This allows for easier chaining of the Lamp.Builder instance

Parameters:

consumer - The consumer to perform

Returns:

This builder instance

See Also:

Hooks

annotationReplacer

public <T extends java.lang.annotation.Annotation> Lamp.Builder<A> annotationReplacer(@NotNull
                                                                                      @NotNull java.lang.Class<T> annotationType,
                                                                                      @NotNull
                                                                                      @NotNull AnnotationReplacer<T> replacer)

Registers an AnnotationReplacer for a specified annotation type

Type Parameters:

T - The replaced annotation type

Parameters:

annotationType - Annotation to replace

replacer - The annotation replacer

Returns:

This builder instance

See Also:

AnnotationReplacer, AnnotationList

senderResolver

public Lamp.Builder<A> senderResolver(@NotNull
                                      @NotNull SenderResolver<? super A> resolver)

Registers a SenderResolver which is responsible for parsing the first parameter in the command and testing if it should be assumed the sender type

Parameters:

resolver - The sender resolver

Returns:

This builder instance

See Also:

SenderResolver

parameterValidator

public <T> Lamp.Builder<A> parameterValidator(java.lang.Class<T> type,
                                              @NotNull
                                              @NotNull ParameterValidator<? super A,T> validator)

Registers a ParameterValidator which validates certain types of parameters that get resolved by ParameterTypes

Type Parameters:

T - The parameter type

Parameters:

type - The parameter type

validator - The validator

Returns:

This builder instance

See Also:

ParameterValidator

responseHandler

public <T> Lamp.Builder<A> responseHandler(java.lang.Class<T> type,
                                           @NotNull
                                           @NotNull ResponseHandler<? super A,T> responseHandler)

Registers a ResponseHandler that accepts the objects matching a certain type returned by command functions.

Type Parameters:

T - The response type

Parameters:

type - The response type

responseHandler - The response handler

Returns:

This builder instance

See Also:

ResponseHandler

responseHandler

public Lamp.Builder<A> responseHandler(@NotNull
                                       ResponseHandler.Factory<? super A> responseHandler)

Registers a ResponseHandler.Factory that accepts returned by command functions. This factory can access annotations of the type

Parameters:

responseHandler - The response handler

Returns:

This builder instance

See Also:

ResponseHandler

commandCondition

public Lamp.Builder<A> commandCondition(@NotNull
                                        @NotNull CommandCondition<? super A> condition)

Registers a CommandCondition that is invoked before a command is finally executed

Parameters:

condition - The condition to register

Returns:

This builder instance

See Also:

CommandCondition

permissionFactory

public Lamp.Builder<A> permissionFactory(@NotNull
                                         CommandPermission.Factory<? super A> factory)

Registers a CommandPermission.Factory that creates CommandPermissions for commands and parameters

Parameters:

factory - The permission factory

Returns:

This builder factory

See Also:

CommandPermission.Factory, CommandPermission

permissionForAnnotation

public <T extends java.lang.annotation.Annotation> Lamp.Builder<A> permissionForAnnotation(@NotNull
                                                                                           @NotNull java.lang.Class<T> annotationType,
                                                                                           @NotNull
                                                                                           @NotNull java.util.function.Function<T,CommandPermission<A>> permissionCreator)

Registers a CommandPermission function that creates CommandPermissions for commands and parameters that have the given

Parameters:

annotationType - The annotation type

permissionCreator - The permission creator function

Returns:

This builder factory

See Also:

CommandPermission.Factory, CommandPermission

exceptionHandler

public Lamp.Builder<A> exceptionHandler(@NotNull
                                        @NotNull CommandExceptionHandler<A> handler)

Sets the registered exception handler that handles all exceptions passed to this builder.

Parameters:

handler - The exception handler

Returns:

This builder

See Also:

CommandExceptionHandler

dependency

public <T> Lamp.Builder<A> dependency(java.lang.Class<T> dependencyType,
                                      @NotNull
                                      T dependency)

Registers the given dependency as an object

Type Parameters:

T - The dependency type

Parameters:

dependencyType - The dependency class

dependency - The dependency object

Returns:

This builder instance

See Also:

Dependency

dependency

public <T> Lamp.Builder<A> dependency(java.lang.Class<T> dependencyType,
                                      @NotNull
                                      @NotNull java.util.function.Supplier<T> dependency)

Registers the given dependency as a supplier that will provide the values as needed

Type Parameters:

T - The dependency type

Parameters:

dependencyType - The dependency class

dependency - The dependency supplier

Returns:

This builder instance

See Also:

Dependency

defaultMessageSender

public Lamp.Builder<A> defaultMessageSender(@NotNull
                                            @NotNull MessageSender<? super A,java.lang.String> messageSender)

Registers the default message sender used by CommandActor.reply(String)

Parameters:

messageSender - The sender to use

Returns:

This builder instance

defaultErrorSender

public Lamp.Builder<A> defaultErrorSender(@NotNull
                                          @NotNull MessageSender<? super A,java.lang.String> messageSender)

Registers the default message sender used by CommandActor.error(String)

Parameters:

messageSender - The sender to use

Returns:

This builder instance

accept

@Contract(value="_ -> this")
 @NotNull
public @NotNull Lamp.Builder<A> accept(@NotNull
                                                                              @NotNull LampBuilderVisitor<? super A> visitor)

Accepts the given visitor by calling LampBuilderVisitor#visit(Builder) on this Lamp.Builder instance

Parameters:

visitor - Visitor to accept

Returns:

This builder instance

build

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

Constructs a Lamp from this Lamp.Builder. All lists are copied and turned immutable.

Returns:

The created Lamp instance.