org.spongepowered.api.command.dispatcher

Interface Dispatcher

All Superinterfaces:

CommandCallable

All Known Subinterfaces:

CommandManager

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	containsAlias(String alias) Returns whether the dispatcher contains a registered command for the given alias.
boolean	containsMapping(CommandMapping mapping) Returns whether the dispatcher contains the given mapping.
Optional<? extends CommandMapping>	get(String alias) Gets the CommandMapping associated with an alias.
Optional<? extends CommandMapping>	get(String alias, CommandSource source) Gets the CommandMapping associated with an alias in the context of a given CommandSource.
Set<String>	getAliases() Gets a list of all the command aliases, which includes the primary alias.
Multimap<String,CommandMapping>	getAll() Gets all commands currently registered with this dispatcher.
Set<? extends CommandMapping>	getAll(String alias) Gets all the CommandMappings associated with an alias.
Set<? extends CommandMapping>	getCommands() Gets a list of commands.
Set<String>	getPrimaryAliases() Gets a list of primary aliases.

Methods inherited from interface org.spongepowered.api.command.CommandCallable

getHelp, getShortDescription, getSuggestions, getUsage, process, testPermission

Method Detail

getCommands

Set<? extends CommandMapping> getCommands()

Gets 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

Set<String> getPrimaryAliases()

Gets a list of primary aliases.

The returned collection cannot be modified.

Returns:

A list of aliases

getAliases

Set<String> getAliases()

Gets 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

Optional<? extends CommandMapping> get(String alias)

Gets the CommandMapping associated with an alias. Returns null if no command is named by the given alias.

Parameters:

alias - The alias

Returns:

The command mapping, if available

get

Optional<? extends CommandMapping> get(String alias,
                                       @Nullable
                                       CommandSource source)

Gets the CommandMapping associated with an alias in the context of a given CommandSource. Returns null if no command is named by the given alias.

Parameters:

alias - The alias to look up

source - The source this alias is being looked up for

Returns:

The command mapping, if available

getAll

Set<? extends CommandMapping> getAll(String alias)

Gets all the CommandMappings associated with an alias.

Parameters:

alias - The alias

Returns:

The command mappings associated with the alias

getAll

Multimap<String,CommandMapping> getAll()

Gets all commands currently registered with this dispatcher. The returned value is immutable.

Returns:

a multimap from alias to mapping of every registered command

containsAlias

boolean containsAlias(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

containsMapping

boolean containsMapping(CommandMapping mapping)

Returns whether the dispatcher contains the given mapping.

Parameters:

mapping - The mapping

Returns:

True if a mapping exists