com.sk89q.worldedit.util.command

Interface CommandCallable

All Superinterfaces:

CommandCompleter

All Known Subinterfaces:

Dispatcher

All Known Implementing Classes:

SimpleDispatcher

public interface CommandCallable
extends CommandCompleter

A command that can be executed.

Method Summary

Modifier and Type	Method and Description
boolean	call(String arguments, CommandLocals locals, String[] parentCommands) Execute the correct command based on the input.
Description	getDescription() Get an object describing this command.
boolean	testPermission(CommandLocals locals) Test whether this command can be executed with the given context.

Methods inherited from interface com.sk89q.worldedit.util.command.CommandCompleter

getSuggestions

Method Detail

call

boolean call(String arguments,
             CommandLocals locals,
             String[] parentCommands)
      throws CommandException

Execute the correct command based on the input.

The implementing class must perform the necessary permission checks.

Parameters:

arguments - the arguments

locals - the locals

parentCommands - a list of parent commands, with the first most entry being the top-level command

Returns:

the called command, or null if there was no command found

Throws:

CommandException - thrown on a command error

getDescription

Description getDescription()

Get an object describing this command.

Returns:

the command description

testPermission

boolean testPermission(CommandLocals locals)

Test whether this command can be executed with the given context.

Parameters:

locals - the locals

Returns:

true if execution is permitted