org.spongepowered.api.command.spec

Class CommandSpec

java.lang.Object

org.spongepowered.api.command.spec.CommandSpec

All Implemented Interfaces:

CommandCallable

public final class CommandSpec
extends Object
implements CommandCallable

Specification for how command arguments should be parsed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandSpec.Builder Builder for command specs.

Method Summary

Modifier and Type	Method and Description
static CommandSpec.Builder	builder() Return a new builder for a CommandSpec.
void	checkPermission(CommandSource source) Check the relevant permission for this command with the provided source, throwing an exception if the source does not have permission to use the command.
List<String>	complete(CommandSource source, CommandArgs args, CommandContext context) Return tab completion results using the existing parsed arguments and context.
boolean	equals(Object o)
CommandExecutor	getExecutor() Gets the active executor for this command.
Optional<Text>	getExtendedDescription(CommandSource source) Gets the extended description used with this command if any is present.
Optional<Text>	getHelp(CommandSource source) Return a longer description for this command.
InputTokenizer	getInputTokenizer() Gets the active input tokenizer used for this command.
Optional<Text>	getShortDescription(CommandSource source) Gets a short, one-line description used with this command if any is present.
List<String>	getSuggestions(CommandSource source, String arguments, Location<World> targetPos) Gets a list of suggestions based on input.
Text	getUsage(CommandSource source) Gets the usage for this command appropriate for the provided command source.
int	hashCode()
void	populateContext(CommandSource source, CommandArgs args, CommandContext context) Process this command with existing arguments and context objects.
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static CommandSpec.Builder builder()

Return a new builder for a CommandSpec.

Returns:

a new builder

checkPermission

public void checkPermission(CommandSource source)
                     throws CommandException

Check the relevant permission for this command with the provided source, throwing an exception if the source does not have permission to use the command.

Parameters:

source - The source to check

Throws:

CommandException - if the source does not have permission

populateContext

public void populateContext(CommandSource source,
                            CommandArgs args,
                            CommandContext context)
                     throws ArgumentParseException

Process this command with existing arguments and context objects.

Parameters:

source - The source to populate the context with

args - The arguments to process with

context - The context to put data in

Throws:

ArgumentParseException - if an invalid argument is provided

complete

public List<String> complete(CommandSource source,
                             CommandArgs args,
                             CommandContext context)

Return tab completion results using the existing parsed arguments and context. Primarily useful when including a subcommand in an existing specification.

Parameters:

source - The source to parse arguments for

args - The arguments object

context - The context object

Returns:

possible completions, or an empty list if none

getExecutor

public CommandExecutor getExecutor()

Gets the active executor for this command. Generally not a good idea to call this directly, unless you are handling arg parsing specially

Returns:

The active executor for this command

getInputTokenizer

public InputTokenizer getInputTokenizer()

Gets the active input tokenizer used for this command.

Returns:

This command's input tokenizer

process

public CommandResult process(CommandSource source,
                             String arguments)
                      throws CommandException

Description copied from interface: CommandCallable

Execute the command based on input arguments.

The implementing class must perform the necessary permission checks.

Specified by:

process in interface CommandCallable

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

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

Description copied from interface: CommandCallable

Gets a list of suggestions based on input.

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

Specified by:

getSuggestions in interface CommandCallable

Parameters:

source - The command source

arguments - The arguments entered up to this point

targetPos - 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

public boolean testPermission(CommandSource source)

Description copied from interface: CommandCallable

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.

Specified by:

testPermission in interface CommandCallable

Parameters:

source - The caller of the command

Returns:

Whether permission is (probably) granted

getShortDescription

public Optional<Text> getShortDescription(CommandSource source)

Gets a short, one-line description used with this command if any is present.

Specified by:

getShortDescription in interface CommandCallable

Parameters:

source - The source of the help request

Returns:

the short description.

getExtendedDescription

public Optional<Text> getExtendedDescription(CommandSource source)

Gets the extended description used with this command if any is present.

Parameters:

source - The source to get the description for

Returns:

the extended description.

getUsage

public Text getUsage(CommandSource source)

Gets the usage for this command appropriate for the provided command source.

Specified by:

getUsage in interface CommandCallable

Parameters:

source - The source

Returns:

the usage for the source

getHelp

public Optional<Text> getHelp(CommandSource source)

Return a longer description for this command. This description is composed of at least all present of the short description, the usage statement, and the extended description

Specified by:

getHelp in interface CommandCallable

Parameters:

source - The source to get the extended description for

Returns:

the extended description

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object