Package org.spongepowered.api.command

Interface Command.Parameterized

All Superinterfaces:

Command

Enclosing interface:

Command

public static interface Command.Parameterized
extends Command

A Command that has distinct steps for parsing arguments and executing a command based on those arguments.

Plugins must not attempt to create their own instance of this interface, and instead must use Command.builder() to do so.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.command.Command

Command.Builder, Command.Parameterized, Command.Raw

Method Summary

Modifier and Type	Method	Description
Predicate<CommandCause>	executionRequirements()	Gets a Predicate that backs Command.canExecute(CommandCause).
Optional<CommandExecutor>	executor()	Gets the CommandExecutor for this command, if one exists.
List<Flag>	flags()	The List of Flags that this Command contains.
boolean	isTerminal()	Gets whether Command.Builder.terminal(boolean) was explicitly set to true, such that this command will execute without any arguments, regardless of the command's parameters or subcommands.
List<Parameter>	parameters()	The List of Parameters that this Command contains.
CommandContext	parseArguments(CommandCause cause, ArgumentReader.Mutable arguments)	Parses the parameters based on the provided parameters()
default CommandResult	process(CommandCause cause, ArgumentReader.Mutable arguments)	Processes the command by parsing the arguments, then executing command based on these arguments.
List<Parameter.Subcommand>	subcommands()	A List of direct subcommands that this command contains.

Methods inherited from interface org.spongepowered.api.command.Command

canExecute, complete, extendedDescription, help, shortDescription, usage

Method Detail

flags

List<Flag> flags()

The List of Flags that this Command contains.

Returns:

A copy of the collection of Flags.

parameters

List<Parameter> parameters()

The List of Parameters that this Command contains.

Returns:

A copy of the collection of Parameters.

subcommands

List<Parameter.Subcommand> subcommands()

A List of direct subcommands that this command contains.

A direct subcommand is one that is specified directly after the literal the invokes this command, e.g. on the command /foo, bar is a direct subcommand if it was specified in Command.Builder.addChild(Parameterized, String...) or Command.Builder.addChildren(Map) with the alias bar. This will not contain any subcommands that were registered via Command.Builder.addParameter(Parameter)

Returns:

A copy of the collection of subcommands.

isTerminal

boolean isTerminal()

Gets whether Command.Builder.terminal(boolean) was explicitly set to true, such that this command will execute without any arguments, regardless of the command's parameters or subcommands.

Returns:

if this Command.Parameterized is terminal.

executionRequirements

Predicate<CommandCause> executionRequirements()

Gets a Predicate that backs Command.canExecute(CommandCause).

Returns:

The predicate.

parseArguments

CommandContext parseArguments(CommandCause cause,
                              ArgumentReader.Mutable arguments)
                       throws ArgumentParseException

Parses the parameters based on the provided parameters()

Parameters:

cause - The Cause of this parse

arguments - The argument String

Returns:

The CommandContext

Throws:

ArgumentParseException - if a parameter could not be parsed

executor

Optional<CommandExecutor> executor()

Gets the CommandExecutor for this command, if one exists.

Returns:

The CommandExecutor, if it exists.

process

default CommandResult process(CommandCause cause,
                              ArgumentReader.Mutable arguments)
                       throws CommandException

Processes the command by parsing the arguments, then executing command based on these arguments.

By default, this will call parseArguments(CommandCause, ArgumentReader.Mutable) and pass the resulting CommandContext to CommandExecutor.execute(CommandContext), if this command has an executor. If it does not, this will throw a CommandException.

Specified by:

process in interface Command

Parameters:

cause - The Cause 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