net.lenni0451.commandlib

Class CommandExecutor<E>

java.lang.Object

net.lenni0451.commandlib.CommandExecutor<E>

Type Parameters:

E - The type of the executor

public class CommandExecutor<E>
extends java.lang.Object

The handler for all registered commands.

Constructor Summary

Constructors

Constructor and Description
CommandExecutor()
CommandExecutor(ArgumentComparator argumentComparator)

Method Summary

Modifier and Type	Method and Description
java.util.Set<Completion>	completions(E executor, java.lang.String command) Get completions for the given command input.
java.util.Set<Completion>	completions(E executor, StringReader reader) Get completions for the given command input.
<T> T	execute(E executor, java.lang.String command) Execute the given command input.
<T> T	execute(E executor, StringReader reader) Execute the given command input.
void	register(ArgumentNode<E,?> argumentNode) Register an argument node.
void	register(StringNode<E> stringNode) Register a string argument node.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandExecutor

public CommandExecutor()

CommandExecutor

public CommandExecutor(ArgumentComparator argumentComparator)

Method Detail

register

public void register(ArgumentNode<E,?> argumentNode)

Register an argument node.
The argument node must be a StringNode.
This method just exists for convenience. See register(StringNode).

Parameters:

argumentNode - The argument node

register

public void register(StringNode<E> stringNode)

Register a string argument node.

Parameters:

stringNode - The string argument node

completions

public java.util.Set<Completion> completions(@Nonnull
                                             E executor,
                                             @Nonnull
                                             java.lang.String command)

Get completions for the given command input.

Parameters:

executor - The executor

command - The command input

Returns:

The sorted completions

completions

public java.util.Set<Completion> completions(@Nonnull
                                             E executor,
                                             @Nonnull
                                             StringReader reader)

Get completions for the given command input.

Parameters:

executor - The executor

reader - The string reader

Returns:

The sorted completions

execute

@Nullable
public <T> T execute(@Nonnull
                                E executor,
                                @Nonnull
                                java.lang.String command)
                         throws CommandExecutionException

Execute the given command input.

Type Parameters:

T - The return type of the executed command

Parameters:

executor - The executor

command - The command input

Returns:

The return value of the executed command

Throws:

CommandExecutionException - If the command execution failed

execute

@Nullable
public <T> T execute(@Nonnull
                                E executor,
                                @Nonnull
                                StringReader reader)
                         throws CommandExecutionException

Execute the given command input.

Type Parameters:

T - The return type of the executed command

Parameters:

executor - The executor

reader - The string reader

Returns:

The return value of the executed command

Throws:

CommandExecutionException - If the command execution failed