org.spongepowered.api.command

Class ImmutableCommandMapping

java.lang.Object

org.spongepowered.api.command.ImmutableCommandMapping

All Implemented Interfaces:

CommandMapping

public final class ImmutableCommandMapping
extends Object
implements CommandMapping

An immutable command mapping instance that returns the same objects that this instance is constructed with.

Constructor Summary

Constructors

Constructor and Description
ImmutableCommandMapping(CommandCallable callable, String primary, Collection<String> aliases) Create a new instance.
ImmutableCommandMapping(CommandCallable callable, String primary, String... alias) Create a new instance.

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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableCommandMapping

public ImmutableCommandMapping(CommandCallable callable,
                               String primary,
                               String... alias)

Create a new instance.

Parameters:

callable - The command callable

primary - The primary alias

alias - A list of all aliases

Throws:

IllegalArgumentException - Thrown if aliases are duplicated

ImmutableCommandMapping

public ImmutableCommandMapping(CommandCallable callable,
                               String primary,
                               Collection<String> aliases)

Create a new instance.

Parameters:

callable - The command callable

primary - The primary alias

aliases - A collection of all aliases

Throws:

IllegalArgumentException - Thrown if aliases are duplicated

Method Detail

getPrimaryAlias

public String getPrimaryAlias()

Description copied from interface: CommandMapping

Gets the primary alias.

Specified by:

getPrimaryAlias in interface CommandMapping

Returns:

The primary alias

getAllAliases

public Set<String> getAllAliases()

Description copied from interface: CommandMapping

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 CommandMapping.getPrimaryAlias().

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

Specified by:

getAllAliases in interface CommandMapping

Returns:

A set of aliases

getCallable

public CommandCallable getCallable()

Description copied from interface: CommandMapping

Gets the callable.

Specified by:

getCallable in interface CommandMapping

Returns:

The callable

toString

public String toString()

Overrides:

toString in class Object