revxrsal.commands.node

Interface CommandRegistry<A extends CommandActor>

Type Parameters:

A - The actor type

All Superinterfaces:

java.lang.Iterable<ExecutableCommand<A>>

All Known Implementing Classes:

BaseCommandRegistry

public interface CommandRegistry<A extends CommandActor>
extends java.lang.Iterable<ExecutableCommand<A>>

Represents a registry of commands maintained by a Lamp instance.

This can be accessed with Lamp.registry()

Method Summary

Modifier and Type	Method and Description
boolean	any(@NotNull java.util.function.Predicate<ExecutableCommand<A>> matches) Tests whether any of the registered commands matches the given predicate
@NotNull @UnmodifiableView java.util.List<ExecutableCommand<A>>	commands() Gets an unmodifiable view of all the commands registered in this registry.
void	execute(A actor, @NotNull ExecutableCommand<A> command, @NotNull MutableStringStream input) Executes the given command on the behalf of the actor.
default void	execute(A actor, @NotNull java.lang.String input) Executes the given input on the behalf of the actor.
void	execute(A actor, @NotNull StringStream input) Executes the given input on the behalf of the actor.
@NotNull java.util.List<ExecutableCommand<A>>	filter(@NotNull java.util.function.Predicate<ExecutableCommand<A>> filterPredicate) Returns a new list of all commands that match the given predicate
@NotNull @UnmodifiableView java.util.Iterator<ExecutableCommand<A>>	iterator() Returns an immutable iterator of all entries in this registry.
@NotNull Lamp<A>	lamp() Returns the underlying Lamp instance of this registry.
void	unregister(@NotNull ExecutableCommand<A> command) Unregisters the given command.
void	unregisterIf(@NotNull java.util.function.Predicate<ExecutableCommand<A>> matches) Unregisters all commands that match a certain Predicate criteria.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

lamp

@NotNull
 @Contract(pure=true)
@NotNull Lamp<A> lamp()

Returns the underlying Lamp instance of this registry.

Returns:

The Lamp instance

execute

default void execute(@NotNull
                     A actor,
                     @NotNull
                     @NotNull java.lang.String input)

Executes the given input on the behalf of the actor.

Parameters:

actor - The actor to execute the command with

input - The input to execute with

execute

void execute(@NotNull
             A actor,
             @NotNull
             @NotNull StringStream input)

Executes the given input on the behalf of the actor.

Parameters:

actor - The actor to execute the command with

input - The input to execute with

execute

void execute(@NotNull
             A actor,
             @NotNull
             @NotNull ExecutableCommand<A> command,
             @NotNull
             @NotNull MutableStringStream input)

Executes the given command on the behalf of the actor. This is faster than execute(CommandActor, StringStream) as it does not involve searching for the command.

Parameters:

actor - The actor to execute the command with

input - The input to execute with

commands

@NotNull
@NotNull @UnmodifiableView java.util.List<ExecutableCommand<A>> commands()

Gets an unmodifiable view of all the commands registered in this registry.

Returns:

all the registered commands

unregister

void unregister(@NotNull
                @NotNull ExecutableCommand<A> command)

Unregisters the given command.

Parameters:

command - The command to unregister.

unregisterIf

void unregisterIf(@NotNull
                  @NotNull java.util.function.Predicate<ExecutableCommand<A>> matches)

Unregisters all commands that match a certain Predicate criteria.

Parameters:

matches - Criteria to test for

any

boolean any(@NotNull
            @NotNull java.util.function.Predicate<ExecutableCommand<A>> matches)

Tests whether any of the registered commands matches the given predicate

Parameters:

matches - Criteria to test for

Returns:

if any command matches the predicate

filter

@NotNull
 @CheckReturnValue
 @Contract(value="_ -> new")
@NotNull java.util.List<ExecutableCommand<A>> filter(@NotNull
                                                                                                              @NotNull java.util.function.Predicate<ExecutableCommand<A>> filterPredicate)

Returns a new list of all commands that match the given predicate

Parameters:

filterPredicate - Criteria to test for

Returns:

a list of all commands that match the predicate

iterator

@NotNull
@NotNull @UnmodifiableView java.util.Iterator<ExecutableCommand<A>> iterator()

Returns an immutable iterator of all entries in this registry.

Attempting to modify the iterator will throw a UnsupportedOperationException.

Specified by:

iterator in interface java.lang.Iterable<ExecutableCommand<A extends CommandActor>>

Returns:

The iterator