com.sk89q.worldedit.util.command

Interface Dispatcher

All Superinterfaces:

CommandCallable, CommandCompleter

All Known Implementing Classes:

SimpleDispatcher

public interface Dispatcher
extends CommandCallable

Executes a command based on user input.

Method Summary

Modifier and Type	Method and Description
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.
Collection<String>	getAliases() Get a list of all the command aliases, which includes the primary alias.
Set<CommandMapping>	getCommands() Get a list of commands.
Collection<String>	getPrimaryAliases() Get a list of primary aliases.
void	registerCommand(CommandCallable callable, String... alias) Register a command with this dispatcher.

Methods inherited from interface com.sk89q.worldedit.util.command.CommandCallable

call, getDescription, testPermission

Methods inherited from interface com.sk89q.worldedit.util.command.CommandCompleter

getSuggestions

Method Detail

registerCommand

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

Register a command with this dispatcher.

Parameters:

callable - the command executor

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

getCommands

Set<CommandMapping> getCommands()

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.

Returns:

a list of registrations

getPrimaryAliases

Collection<String> getPrimaryAliases()

Get a list of primary aliases.

The returned collection cannot be modified.

Returns:

a list of aliases

getAliases

Collection<String> getAliases()

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.

Returns:

a list of aliases

get

@Nullable
CommandMapping get(String alias)

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

Parameters:

alias - the alias

Returns:

the command mapping (null if not found)

contains

boolean contains(String alias)

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

Parameters:

alias - the alias

Returns:

true if a registered command exists