org.spongepowered.api.command

Interface CommandMapping

All Known Implementing Classes:

ImmutableCommandMapping

public interface CommandMapping

Provides information about a mapping between a command and its aliases.

Implementations are not required to implement a sane Object.equals(Object) but may choose to do so.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllAliases() Gets an immutable list of all aliases.
CommandCallable	getCallable() Gets the callable.
String	getPrimaryAlias() Gets the primary alias.

Method Detail

getPrimaryAlias

String getPrimaryAlias()

Gets the primary alias.

Returns:

The primary alias

getAllAliases

Set<String> getAllAliases()

Gets an immutable list of all aliases.

The returned list must contain at least one entry, of which one must be the one returned by getPrimaryAlias().

There may be several versions of the same alias with different casing, although generally implementations should ignore the casing of aliases.

Returns:

A set of aliases

getCallable

CommandCallable getCallable()

Gets the callable.

Returns:

The callable