revxrsal.commands.hook

Class Hooks.Builder<A extends CommandActor>

java.lang.Object

revxrsal.commands.hook.Hooks.Builder<A>

Type Parameters:

A - The actor type

Enclosing class:

Hooks<A extends CommandActor>

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

A builder for Hooks

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
@NotNull Hooks<A>	build() Creates a new Hooks registry from this builder
@NotNull Hooks.Builder<A>	onCommandExecuted(@NotNull CommandExecutedHook<? super A> hook) Adds a hook that runs before a command is executed
@NotNull Hooks.Builder<A>	onCommandRegistered(@NotNull CommandRegisteredHook<? super A> hook) Adds a hook that runs after a command is registered
@NotNull Hooks.Builder<A>	onCommandUnregistered(@NotNull CommandUnregisteredHook<? super A> hook) Adds a hook that runs after a command is unregistered

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

onCommandExecuted

@NotNull
public @NotNull Hooks.Builder<A> onCommandExecuted(@NotNull
                                                            @NotNull CommandExecutedHook<? super A> hook)

Adds a hook that runs before a command is executed

Parameters:

hook - Hook to register

Returns:

this builder

onCommandRegistered

@NotNull
public @NotNull Hooks.Builder<A> onCommandRegistered(@NotNull
                                                              @NotNull CommandRegisteredHook<? super A> hook)

Adds a hook that runs after a command is registered

Parameters:

hook - Hook to register

Returns:

this builder

onCommandUnregistered

@NotNull
public @NotNull Hooks.Builder<A> onCommandUnregistered(@NotNull
                                                                @NotNull CommandUnregisteredHook<? super A> hook)

Adds a hook that runs after a command is unregistered

Parameters:

hook - Hook to register

Returns:

this builder

build

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

Creates a new Hooks registry from this builder

Returns:

The newly created Hooks instance