org.spongepowered.api.command

Interface CommandCallable

All Known Subinterfaces:

CommandManager, Dispatcher

All Known Implementing Classes:

CommandSpec, SimpleDispatcher

public interface CommandCallable

A low-level interface for commands that can be executed. For almost all use cases, higher-level tools should be used instead, like CommandSpec.

Implementations are not required to implement a sane Object.equals(Object) but really should.

Method Summary

Modifier and Type	Method and Description
Optional<Text>	getHelp(CommandSource source) Gets a longer formatted help message about this command.
Optional<Text>	getShortDescription(CommandSource source) Gets a short one-line description of this command.
List<String>	getSuggestions(CommandSource source, String arguments, Location<World> targetPosition) Gets a list of suggestions based on input.
Text	getUsage(CommandSource source) Gets the usage string of this command.
CommandResult	process(CommandSource source, String arguments) Execute the command based on input arguments.
boolean	testPermission(CommandSource source) Test whether this command can probably be executed by the given source.

Method Detail

process

CommandResult process(CommandSource source,
                      String arguments)
               throws CommandException

Execute the command based on input arguments.

The implementing class must perform the necessary permission checks.

Parameters:

source - The caller of the command

arguments - The raw arguments for this command

Returns:

The result of a command being processed

Throws:

CommandException - Thrown on a command error

getSuggestions

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

Gets a list of suggestions based on input.

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

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

Throws:

CommandException - Thrown if there was a parsing error

testPermission

boolean testPermission(CommandSource source)

Test whether this command can probably be executed by the given source.

If implementations are unsure if the command can be executed by the source, true should be returned. Return values of this method may be used to determine whether this command is listed in command listings.

Parameters:

source - The caller of the command

Returns:

Whether permission is (probably) granted

getShortDescription

Optional<Text> getShortDescription(CommandSource source)

Gets a short one-line description of this command.

The help system may display the description in the command list.

Parameters:

source - The source of the help request

Returns:

A description

getHelp

Optional<Text> getHelp(CommandSource source)

Gets a longer formatted help message about this command.

It is recommended to use the default text color and style. Sections with text actions (e.g. hyperlinks) should be underlined.

Multi-line messages can be created by separating the lines with \n.

The help system may display this message when a source requests detailed information about a command.

Parameters:

source - The source of the help request

Returns:

A help text

getUsage

Text getUsage(CommandSource source)

Gets the usage string of this command.

A usage string may look like [-w <world>] <var1> <var2>.

The string must not contain the command alias.

Parameters:

source - The source of the help request

Returns:

A usage string