org.spongepowered.api.command

Interface CommandManager

All Superinterfaces:

CommandCallable, Dispatcher

public interface CommandManager
extends Dispatcher

A command dispatcher watches for commands (such as those said in chat) and dispatches them to the correct command handler.

Method Summary

Modifier and Type	Method and Description
Set<CommandMapping>	getOwnedBy(Object instance) Gets a set of commands owned by the given plugin instance.
Optional<PluginContainer>	getOwner(CommandMapping mapping) Gets the owner of a CommandMapping, if any is present.
Set<PluginContainer>	getPluginContainers() Gets a set of plugin containers that have commands registered.
List<String>	getSuggestions(CommandSource source, String arguments, Location<World> targetPosition) Gets a list of suggestions based on input.
CommandResult	process(CommandSource source, String arguments) Execute the command based on input arguments.
Optional<CommandMapping>	register(Object plugin, CommandCallable callable, List<String> aliases) Register a given command using the given list of aliases.
Optional<CommandMapping>	register(Object plugin, CommandCallable callable, List<String> aliases, Function<List<String>,List<String>> callback) Register a given command using a given list of aliases.
Optional<CommandMapping>	register(Object plugin, CommandCallable callable, String... alias) Register a given command using the given list of aliases.
Optional<CommandMapping>	removeMapping(CommandMapping mapping) Remove a command identified by the given mapping.
int	size() Gets the number of registered aliases.

Methods inherited from interface org.spongepowered.api.command.dispatcher.Dispatcher

containsAlias, containsMapping, get, get, getAliases, getAll, getAll, getCommands, getPrimaryAliases

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

getHelp, getShortDescription, getUsage, testPermission

Method Detail

register

Optional<CommandMapping> register(Object plugin,
                                  CommandCallable callable,
                                  String... alias)

Register a given command using the given list of aliases.

If there is a conflict with one of the aliases (i.e. that alias is already assigned to another command), then the alias will be skipped. It is possible for there to be no alias to be available out of the provided list of aliases, which would mean that the command would not be assigned to any aliases.

The first non-conflicted alias becomes the "primary alias."

Parameters:

plugin - A plugin instance

callable - The command

alias - An array of aliases

Returns:

The registered command mapping, unless no aliases could be registered

Throws:

IllegalArgumentException - Thrown if plugin is not a plugin instance

register

Optional<CommandMapping> register(Object plugin,
                                  CommandCallable callable,
                                  List<String> aliases)

Register a given command using the given list of aliases.

If there is a conflict with one of the aliases (i.e. that alias is already assigned to another command), then the alias will be skipped. It is possible for there to be no alias to be available out of the provided list of aliases, which would mean that the command would not be assigned to any aliases.

The first non-conflicted alias becomes the "primary alias."

Parameters:

plugin - A plugin instance

callable - The command

aliases - A list of aliases

Returns:

The registered command mapping, unless no aliases could be registered

Throws:

IllegalArgumentException - Thrown if plugin is not a plugin instance

register

Optional<CommandMapping> register(Object plugin,
                                  CommandCallable callable,
                                  List<String> aliases,
                                  Function<List<String>,List<String>> callback)

Register a given command using a given list of aliases.

The provided callback function will be called with a list of aliases that are not taken (from the list of aliases that were requested) and it should return a list of aliases to actually register. Aliases may be removed, and if no aliases remain, then the command will not be registered. It may be possible that no aliases are available, and thus the callback would receive an empty list. New aliases should not be added to the list in the callback as this may cause IllegalArgumentException to be thrown.

The first non-conflicted alias becomes the "primary alias."

Parameters:

plugin - A plugin instance

callable - The command

aliases - A list of aliases

callback - The callback

Returns:

The registered command mapping, unless no aliases could be registered

Throws:

IllegalArgumentException - Thrown if new conflicting aliases are added in the callback

IllegalArgumentException - Thrown if plugin is not a plugin instance

removeMapping

Optional<CommandMapping> removeMapping(CommandMapping mapping)

Remove a command identified by the given mapping.

Parameters:

mapping - The mapping

Returns:

The previous mapping associated with the alias, if one was found

getPluginContainers

Set<PluginContainer> getPluginContainers()

Gets a set of plugin containers that have commands registered.

Returns:

A set of plugin containers

getOwnedBy

Set<CommandMapping> getOwnedBy(Object instance)

Gets a set of commands owned by the given plugin instance.

Parameters:

instance - The plugin instance

Returns:

A set of mappings

getOwner

Optional<PluginContainer> getOwner(CommandMapping mapping)

Gets the owner of a CommandMapping, if any is present.

Parameters:

mapping - The mapping to get an owner for

Returns:

The owner, if present.

size

int size()

Gets the number of registered aliases.

Returns:

The number of aliases

process

CommandResult process(CommandSource source,
                      String arguments)

Execute the command based on input arguments.

The implementing class must perform the necessary permission checks.

Specified by:

process in interface CommandCallable

Parameters:

source - The caller of the command

arguments - The raw arguments for this command

Returns:

The result of a command being processed

getSuggestions

List<String> getSuggestions(CommandSource source,
                            String arguments,
                            @Nullable
                            Location<World> targetPosition)

Gets a list of suggestions based on input.

If a suggestion is chosen by the user, it will replace the last word.

Specified by:

getSuggestions in interface CommandCallable

Parameters:

source - The command source

arguments - The arguments entered up to this point

targetPosition - The position the source is looking at when performing tab completion

Returns:

A list of suggestions