revxrsal.commands.node.parser

Class BaseCommandRegistry<A extends CommandActor>

java.lang.Object

revxrsal.commands.node.parser.BaseCommandRegistry<A>

All Implemented Interfaces:

java.lang.Iterable<ExecutableCommand<A>>, CommandRegistry<A>

@ApiStatus.Internal
public final class BaseCommandRegistry<A extends CommandActor>
extends java.lang.Object
implements CommandRegistry<A>

Constructor Summary

Constructors

Constructor and Description
BaseCommandRegistry(Lamp<A> lamp)
BaseCommandRegistry(Lamp<A> lamp, java.util.List<ExecutableCommand<A>> children)

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.
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 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.
java.util.List<ExecutableCommand<A>>	register(@NotNull java.lang.Class<?> containerClass, java.lang.Object instance)
@NotNull @Unmodifiable java.util.List<ExecutableCommand<A>>	register(@NotNull java.lang.Class<?> containerClass, java.lang.Object instance, @Nullable java.util.List<java.lang.String> orphanPaths)
void	unregister(@NotNull ExecutableCommand<A> execution) 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 class java.lang.Object

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

Methods inherited from interface revxrsal.commands.node.CommandRegistry

execute

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BaseCommandRegistry

public BaseCommandRegistry(Lamp<A> lamp,
                           java.util.List<ExecutableCommand<A>> children)

BaseCommandRegistry

public BaseCommandRegistry(Lamp<A> lamp)

Method Detail

register

public java.util.List<ExecutableCommand<A>> register(@NotNull
                                                     @NotNull java.lang.Class<?> containerClass,
                                                     java.lang.Object instance)

register

@NotNull
public @NotNull @Unmodifiable java.util.List<ExecutableCommand<A>> register(@NotNull
                                                                                     @NotNull java.lang.Class<?> containerClass,
                                                                                     java.lang.Object instance,
                                                                                     @Nullable
                                                                                     @Nullable java.util.List<java.lang.String> orphanPaths)

execute

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

Description copied from interface: CommandRegistry

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

Specified by:

execute in interface CommandRegistry<A extends CommandActor>

Parameters:

actor - The actor to execute the command with

input - The input to execute with

lamp

@NotNull
public @NotNull Lamp<A> lamp()

Description copied from interface: CommandRegistry

Returns the underlying Lamp instance of this registry.

Specified by:

lamp in interface CommandRegistry<A extends CommandActor>

Returns:

The Lamp instance

execute

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

Description copied from interface: CommandRegistry

Executes the given input on the behalf of the actor.

Specified by:

execute in interface CommandRegistry<A extends CommandActor>

Parameters:

actor - The actor to execute the command with

input - The input to execute with

commands

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

Description copied from interface: CommandRegistry

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

Specified by:

commands in interface CommandRegistry<A extends CommandActor>

Returns:

all the registered commands

unregister

public void unregister(@NotNull
                       @NotNull ExecutableCommand<A> execution)

Description copied from interface: CommandRegistry

Unregisters the given command.

Specified by:

unregister in interface CommandRegistry<A extends CommandActor>

Parameters:

execution - The command to unregister.

any

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

Description copied from interface: CommandRegistry

Tests whether any of the registered commands matches the given predicate

Specified by:

any in interface CommandRegistry<A extends CommandActor>

Parameters:

matches - Criteria to test for

Returns:

if any command matches the predicate

filter

@NotNull
public @NotNull java.util.List<ExecutableCommand<A>> filter(@NotNull
                                                                     @NotNull java.util.function.Predicate<ExecutableCommand<A>> filterPredicate)

Description copied from interface: CommandRegistry

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

Specified by:

filter in interface CommandRegistry<A extends CommandActor>

Parameters:

filterPredicate - Criteria to test for

Returns:

a list of all commands that match the predicate

unregisterIf

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

Description copied from interface: CommandRegistry

Unregisters all commands that match a certain Predicate criteria.

Specified by:

unregisterIf in interface CommandRegistry<A extends CommandActor>

Parameters:

matches - Criteria to test for

iterator

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

Description copied from interface: CommandRegistry

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>>

Specified by:

iterator in interface CommandRegistry<A extends CommandActor>

Returns:

The iterator