org.spongepowered.api.command.args

Class ChildCommandElementExecutor

java.lang.Object

org.spongepowered.api.command.args.CommandElement

org.spongepowered.api.command.args.ChildCommandElementExecutor

All Implemented Interfaces:

CommandExecutor

public class ChildCommandElementExecutor
extends CommandElement
implements CommandExecutor

Constructor Summary

Constructors

Constructor and Description
ChildCommandElementExecutor(CommandExecutor fallbackExecutor) Deprecated. Use the other constructor instead. Note: this entire system will be replaced in API 8.
ChildCommandElementExecutor(CommandExecutor fallbackExecutor, CommandElement fallbackElements, boolean fallbackOnFail) Create a new combined argument element and executor to handle the parsing and execution of child commands.

Method Summary

Modifier and Type	Method and Description
List<String>	complete(CommandSource src, CommandArgs args, CommandContext context) Fetch completions for command arguments.
CommandResult	execute(CommandSource src, CommandContext args) Callback for the execution of a command.
Text	getUsage(CommandSource src) Return a usage message for this specific argument.
void	parse(CommandSource source, CommandArgs args, CommandContext context) Attempt to extract a value for this element from the given arguments and put it in the given context.
protected Object	parseValue(CommandSource source, CommandArgs args) Attempt to extract a value for this element from the given arguments.
Optional<CommandMapping>	register(CommandCallable callable, List<String> aliases) Register a child command for a given set of aliases.
Optional<CommandMapping>	register(CommandCallable callable, String... aliases) Register a child command for a given set of aliases.

Methods inherited from class org.spongepowered.api.command.args.CommandElement

getKey, getUntranslatedKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChildCommandElementExecutor

@Deprecated
public ChildCommandElementExecutor(@Nullable
                                               CommandExecutor fallbackExecutor)

Deprecated. Use the other constructor instead. Note: this entire system will be replaced in API 8.

Create a new combined argument element and executor to handle the parsing and execution of child commands.

Parameters:

fallbackExecutor - The executor to execute if the child command has been marked optional (Generally when this is wrapped in a GenericArguments.optional(CommandElement)

ChildCommandElementExecutor

public ChildCommandElementExecutor(@Nullable
                                   CommandExecutor fallbackExecutor,
                                   @Nullable
                                   CommandElement fallbackElements,
                                   boolean fallbackOnFail)

Create a new combined argument element and executor to handle the parsing and execution of child commands.

Parameters:

fallbackExecutor - The executor to execute if the child command has been marked optional (Generally when this is wrapped in a GenericArguments.optional(CommandElement)

fallbackElements - The alternate CommandElements that should be parsed if a child element fails to be parsed

fallbackOnFail - If true, then if a child command cannot parse the elements, the exception is discarded and the parent command attempts to parse the elements. If false, a child command will not pass control back to the parent, displaying its own exception message

Method Detail

register

public Optional<CommandMapping> register(CommandCallable callable,
                                         List<String> aliases)

Register a child command for a given set of aliases.

Parameters:

callable - The command to register

aliases - The aliases to register it as

Returns:

The child command's mapping, if present

register

public Optional<CommandMapping> register(CommandCallable callable,
                                         String... aliases)

Register a child command for a given set of aliases.

Parameters:

callable - The command to register

aliases - The aliases to register it as

Returns:

The child command's mapping, if present

complete

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

Description copied from class: CommandElement

Fetch completions for command arguments.

Specified by:

complete in class CommandElement

Parameters:

src - The source requesting tab completions

args - The arguments currently provided

context - The context to store state in

Returns:

Any relevant completions

parse

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

Description copied from class: CommandElement

Attempt to extract a value for this element from the given arguments and put it in the given context. This method normally delegates to CommandElement.parseValue(CommandSource, CommandArgs) for getting the values. This method is expected to have no side-effects for the source, meaning that executing it will not change the state of the CommandSource in any way.

Overrides:

parse in class CommandElement

Parameters:

source - The source to parse for

args - The args to extract from

context - The context to supply to

Throws:

ArgumentParseException - if unable to extract a value

parseValue

protected Object parseValue(CommandSource source,
                            CommandArgs args)
                     throws ArgumentParseException

Description copied from class: CommandElement

Attempt to extract a value for this element from the given arguments. This method is expected to have no side-effects for the source, meaning that executing it will not change the state of the CommandSource in any way.

Specified by:

parseValue in class CommandElement

Parameters:

source - The source to parse for

args - the arguments

Returns:

The extracted value

Throws:

ArgumentParseException - if unable to extract a value

execute

public CommandResult execute(CommandSource src,
                             CommandContext args)
                      throws CommandException

Description copied from interface: CommandExecutor

Callback for the execution of a command.

Specified by:

execute in interface CommandExecutor

Parameters:

src - The commander who is executing this command

args - The parsed command arguments for this command

Returns:

the result of executing this command

Throws:

CommandException - If a user-facing error occurs while executing this command

getUsage

public Text getUsage(CommandSource src)

Description copied from class: CommandElement

Return a usage message for this specific argument.

Overrides:

getUsage in class CommandElement

Parameters:

src - The source requesting usage

Returns:

The formatted usage