revxrsal.commands.hook

Class Hooks<A extends CommandActor>

java.lang.Object

revxrsal.commands.hook.Hooks<A>

Type Parameters:

A - The actor type

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

An immutable registry of Hooks, which are listeners that allow to execute code at certain points of the command flow.

Each Lamp instance maintains a Hooks registry, which may be modified using Lamp.Builder#hooks().

See Also:

Hook

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Hooks.Builder<A extends CommandActor> A builder for Hooks

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> Hooks.Builder<A>	builder() Creates a new hooks Hooks.Builder
boolean	onCommandExecuted(@NotNull ExecutableCommand<A> command, @NotNull ExecutionContext<A> context) Calls all execution hooks.
boolean	onCommandRegistered(@NotNull ExecutableCommand<A> command) Calls all registration hooks.
boolean	onCommandUnregistered(@NotNull ExecutableCommand<A> command) Calls all un-registration hooks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

@Contract(value="-> new",
          pure=true)
 @NotNull
public static <A extends CommandActor> Hooks.Builder<A> builder()

Creates a new hooks Hooks.Builder

Type Parameters:

A - The actor

Returns:

The newly created builder

onCommandRegistered

@ApiStatus.Internal
public boolean onCommandRegistered(@NotNull
                                                       @NotNull ExecutableCommand<A> command)

Calls all registration hooks.

Parameters:

command - The command that was registered

Returns:

if none of the hooks cancelled the registration

onCommandUnregistered

@ApiStatus.Internal
public boolean onCommandUnregistered(@NotNull
                                                         @NotNull ExecutableCommand<A> command)

Calls all un-registration hooks.

Parameters:

command - The command that was unregistered

Returns:

if none of the hooks cancelled the un-registration

onCommandExecuted

@ApiStatus.Internal
public boolean onCommandExecuted(@NotNull
                                                     @NotNull ExecutableCommand<A> command,
                                                     @NotNull
                                                     @NotNull ExecutionContext<A> context)

Calls all execution hooks.

Parameters:

command - The command that was executed

context - The execution context

Returns:

if none of the hooks cancelled the execution