com.sk89q.worldedit.util.command

Class SimpleDispatcher

java.lang.Object

com.sk89q.worldedit.util.command.SimpleDispatcher

All Implemented Interfaces:

CommandCallable, CommandCompleter, Dispatcher

public class SimpleDispatcher
extends Object
implements Dispatcher

A simple implementation of Dispatcher.

Constructor Summary

Constructors

Constructor and Description
SimpleDispatcher() Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	call(String arguments, CommandLocals locals, String[] parentCommands) Execute the correct command based on the input.
boolean	contains(String alias) Returns whether the dispatcher contains a registered command for the given alias.
CommandMapping	get(String alias) Get the CommandCallable associated with an alias.
Set<String>	getAliases() Get a list of all the command aliases, which includes the primary alias.
Set<CommandMapping>	getCommands() Get a list of commands.
SimpleDescription	getDescription() Get an object describing this command.
Set<String>	getPrimaryAliases() Get a list of primary aliases.
List<String>	getSuggestions(String arguments, CommandLocals locals) Get a list of suggestions based on input.
void	registerCommand(CommandCallable callable, String... alias) Register a command with this dispatcher.
boolean	testPermission(CommandLocals locals) Test whether this command can be executed with the given context.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDispatcher

public SimpleDispatcher()

Create a new instance.

Method Detail

registerCommand

public void registerCommand(CommandCallable callable,
                            String... alias)

Description copied from interface: Dispatcher

Register a command with this dispatcher.

Specified by:

registerCommand in interface Dispatcher

Parameters:

callable - the command executor

alias - a list of aliases, where the first alias is the primary name

getCommands

public Set<CommandMapping> getCommands()

Description copied from interface: Dispatcher

Get a list of commands. Each command, regardless of how many aliases it may have, will only appear once in the returned set.

The returned collection cannot be modified.

Specified by:

getCommands in interface Dispatcher

Returns:

a list of registrations

getAliases

public Set<String> getAliases()

Description copied from interface: Dispatcher

Get a list of all the command aliases, which includes the primary alias.

A command may have more than one alias assigned to it. The returned collection cannot be modified.

Specified by:

getAliases in interface Dispatcher

Returns:

a list of aliases

getPrimaryAliases

public Set<String> getPrimaryAliases()

Description copied from interface: Dispatcher

Get a list of primary aliases.

The returned collection cannot be modified.

Specified by:

getPrimaryAliases in interface Dispatcher

Returns:

a list of aliases

contains

public boolean contains(String alias)

Description copied from interface: Dispatcher

Returns whether the dispatcher contains a registered command for the given alias.

Specified by:

contains in interface Dispatcher

Parameters:

alias - the alias

Returns:

true if a registered command exists

get

public CommandMapping get(String alias)

Description copied from interface: Dispatcher

Get the CommandCallable associated with an alias. Returns null if no command is named by the given alias.

Specified by:

get in interface Dispatcher

Parameters:

alias - the alias

Returns:

the command mapping (null if not found)

call

public boolean call(String arguments,
                    CommandLocals locals,
                    String[] parentCommands)
             throws CommandException

Description copied from interface: CommandCallable

Execute the correct command based on the input.

The implementing class must perform the necessary permission checks.

Specified by:

call in interface CommandCallable

Parameters:

arguments - the arguments

locals - the locals

parentCommands - a list of parent commands, with the first most entry being the top-level command

Returns:

the called command, or null if there was no command found

Throws:

CommandException - thrown on a command error

getSuggestions

public List<String> getSuggestions(String arguments,
                                   CommandLocals locals)
                            throws CommandException

Description copied from interface: CommandCompleter

Get a list of suggestions based on input.

Specified by:

getSuggestions in interface CommandCompleter

Parameters:

arguments - the arguments entered up to this point

locals - the locals

Returns:

a list of suggestions

Throws:

CommandException - thrown if there was a parsing error

getDescription

public SimpleDescription getDescription()

Description copied from interface: CommandCallable

Get an object describing this command.

Specified by:

getDescription in interface CommandCallable

Returns:

the command description

testPermission

public boolean testPermission(CommandLocals locals)

Description copied from interface: CommandCallable

Test whether this command can be executed with the given context.

Specified by:

testPermission in interface CommandCallable

Parameters:

locals - the locals

Returns:

true if execution is permitted