de.dytanic.cloudnet.command

Class CommandManager

java.lang.Object

de.dytanic.cloudnet.command.CommandManager

All Implemented Interfaces:

jline.console.completer.Completer

public final class CommandManager
extends Object
implements jline.console.completer.Completer

Class that manages commands for the interfaces of CloudNet.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Command>	commands
private ConsoleCommandSender	consoleSender

Constructor Summary

Constructors

Constructor and Description
CommandManager() Constructs a new command manager with a ConsoleCommandSender and no commands.

Method Summary

Modifier and Type	Method and Description
CommandManager	clearCommands() Clears all the commands that are currently registered.
int	complete(String buffer, int cursor, List<CharSequence> candidates)
boolean	dispatchCommand(CommandSender sender, String command) Parses the given command and dispatches it using the given sender.
boolean	dispatchCommand(String command) Parses the given command from the console and dispatches it using a ConsoleCommandSender.
Command	getCommand(String name) Get the command for a given name.
Set<String>	getCommands() Get the registered commands.
ConsoleCommandSender	getConsoleSender()
CommandManager	registerCommand(Command command) Register a new command and all of its aliases to this command manager.

Methods inherited from class java.lang.Object

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

Field Detail

commands

private final Map<String,Command> commands

consoleSender

private ConsoleCommandSender consoleSender

Constructor Detail

CommandManager

public CommandManager()

Constructs a new command manager with a ConsoleCommandSender and no commands.

Method Detail

clearCommands

public CommandManager clearCommands()

Clears all the commands that are currently registered.

Returns:

the command manager this was called on, allows for chaining

registerCommand

public CommandManager registerCommand(Command command)

Register a new command and all of its aliases to this command manager.

Parameters:

command - the command to register

Returns:

the command manager this was called on, allows for chaining

getCommands

public Set<String> getCommands()

Get the registered commands.

Returns:

a set containing all the registered command names and aliases

getConsoleSender

public ConsoleCommandSender getConsoleSender()

dispatchCommand

public boolean dispatchCommand(String command)

Parses the given command from the console and dispatches it using a ConsoleCommandSender.

1. First all arguments get processed by the CommandArgument handlers.
2. Then the Command is executed with the processed commands
3. Last all arguments are processed again

Parameters:

command - the command line to parse and dispatch

Returns:

whether the command executed successfully

See Also:

dispatchCommand(CommandSender, String)

dispatchCommand

public boolean dispatchCommand(CommandSender sender,
                               String command)

Parses the given command and dispatches it using the given sender.

1. First all arguments get processed by the CommandArgument handlers.
2. Then the Command is executed with the processed commands
3. Last all arguments are processed again

Parameters:

sender - the sender to execute the command as

command - the command line to parse and dispatch

Returns:

whether the command executed successfully

complete

public int complete(String buffer,
                    int cursor,
                    List<CharSequence> candidates)

Specified by:

complete in interface jline.console.completer.Completer

getCommand

public Command getCommand(String name)

Get the command for a given name.

Parameters:

name - the name to get the command for

Returns:

the command, if there is one with the given name or alias or null, if no command matches the name