com.sk89q.intake

Interface CommandCallable

All Superinterfaces:

CommandCompleter

All Known Subinterfaces:

Dispatcher

All Known Implementing Classes:

AbstractParametricCallable, SimpleDispatcher

public interface CommandCallable
extends CommandCompleter

A command that can be executed.

Method Summary

Modifier and Type	Method and Description
boolean	call(String arguments, Namespace namespace, List<String> parentCommands) Execute the command.
Description	getDescription() Get the object describing the command.
boolean	testPermission(Namespace namespace) Test whether the user is permitted to use the command.

Methods inherited from interface com.sk89q.intake.completion.CommandCompleter

getSuggestions

Method Detail

call

boolean call(String arguments,
             Namespace namespace,
             List<String> parentCommands)
      throws CommandException,
             InvocationCommandException,
             AuthorizationException

Execute the command.

parentCommands is a list of "parent" commands, including the current command, where each deeper command is appended to the list of parent commands.

For example, if the command entered was /world create ocean and the command in question was the "create" command, then:

• arguments would be ocean
• parentCommands would be world create

On the other hand, if the command was "world," then:

• arguments would be create ocean
• parentCommands would be world

Parameters:

arguments - The arguments

namespace - Additional values used for execution

parentCommands - The list of parent commands

Returns:

Whether the command succeeded

Throws:

CommandException - If there is an error with the command

InvocationCommandException - If there is an error with executing the command

AuthorizationException - If there is a authorization error

getDescription

Description getDescription()

Get the object describing the command.

Returns:

The object describing the command

testPermission

boolean testPermission(Namespace namespace)

Test whether the user is permitted to use the command.

Parameters:

namespace - The namespace

Returns:

Whether permission is provided