org.spongepowered.api.command.spec

Class CommandSpec.Builder

java.lang.Object

org.spongepowered.api.command.spec.CommandSpec.Builder

Enclosing class:

CommandSpec

public static final class CommandSpec.Builder
extends Object

Builder for command specs.

Method Summary

Modifier and Type	Method and Description
CommandSpec.Builder	arguments(CommandElement... args) Sets the argument specification for this command.
CommandSpec.Builder	arguments(CommandElement args) Sets the argument specification for this command.
CommandSpec	build() Create a new CommandSpec based on the data provided in this builder.
CommandSpec.Builder	child(CommandCallable child, Collection<String> aliases) Add a single child command to this command.
CommandSpec.Builder	child(CommandCallable child, String... aliases) Add a single child command to this command.
CommandSpec.Builder	childArgumentParseExceptionFallback(boolean childCommandFallback) If a child command is selected but fails to parse arguments passed to it, the following determines the behavior.
CommandSpec.Builder	children(Map<List<String>,? extends CommandCallable> children) Adds more child arguments for this command.
CommandSpec.Builder	description(Text description) A short, one-line description of this command's purpose.
CommandSpec.Builder	executor(CommandExecutor executor) Sets the callback that will handle this command's execution.
CommandSpec.Builder	extendedDescription(Text extendedDescription) Sets an extended description to use in longer help listings for this command.
CommandSpec.Builder	inputTokenizer(InputTokenizer parser) Sets the input tokenizer to be used to convert input from a string into a list of argument tokens.
CommandSpec.Builder	permission(String permission) Sets the permission that will be checked before using this command.

Methods inherited from class java.lang.Object

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

Method Detail

permission

public CommandSpec.Builder permission(String permission)

Sets the permission that will be checked before using this command.

Parameters:

permission - The permission to check

Returns:

this

executor

public CommandSpec.Builder executor(CommandExecutor executor)

Sets the callback that will handle this command's execution.

Parameters:

executor - The executor that will be called with this command's parsed arguments

Returns:

this

children

public CommandSpec.Builder children(Map<List<String>,? extends CommandCallable> children)

Adds more child arguments for this command. If an executor or arguments are set, they are used as fallbacks.

Parameters:

children - The children to use

Returns:

this

child

public CommandSpec.Builder child(CommandCallable child,
                                 String... aliases)

Add a single child command to this command.

Parameters:

child - The child to add

aliases - Aliases to make the child available under. First one is primary and is the only one guaranteed to be listed in usage outputs.

Returns:

this

child

public CommandSpec.Builder child(CommandCallable child,
                                 Collection<String> aliases)

Add a single child command to this command.

Parameters:

child - The child to add.

aliases - Aliases to make the child available under. First one is primary and is the only one guaranteed to be listed in usage outputs.

Returns:

this

description

public CommandSpec.Builder description(@Nullable
                                       Text description)

A short, one-line description of this command's purpose.

Parameters:

description - The description to set

Returns:

this

extendedDescription

public CommandSpec.Builder extendedDescription(@Nullable
                                               Text extendedDescription)

Sets an extended description to use in longer help listings for this command. Will be appended to the short description and the command's usage.

Parameters:

extendedDescription - The description to set

Returns:

this

childArgumentParseExceptionFallback

public CommandSpec.Builder childArgumentParseExceptionFallback(boolean childCommandFallback)

If a child command is selected but fails to parse arguments passed to it, the following determines the behavior.

• If this is set to false, this command (the parent) will not attempt to parse the command, and will send back the error from the child.
• If this is set to true, the error from the child will simply be discarded, and the parent command will execute.

The default for this is true, which emulates the behavior from previous API revisions.

Parameters:

childCommandFallback - Whether to fallback on argument parse failure

Returns:

this

arguments

public CommandSpec.Builder arguments(CommandElement args)

Sets the argument specification for this command. Generally, for a multi-argument command the GenericArguments.seq(CommandElement...) method is used to parse a sequence of args.

Parameters:

args - The arguments object to use

Returns:

this

See Also:

GenericArguments

arguments

public CommandSpec.Builder arguments(CommandElement... args)

Sets the argument specification for this command. This method accepts a sequence of arguments. This is equivalent to calling arguments(seq(args)).

Parameters:

args - The arguments object to use

Returns:

this

See Also:

GenericArguments

inputTokenizer

public CommandSpec.Builder inputTokenizer(InputTokenizer parser)

Sets the input tokenizer to be used to convert input from a string into a list of argument tokens.

Parameters:

parser - The parser to use

Returns:

this

See Also:

for common input parser implementations

build

public CommandSpec build()

Create a new CommandSpec based on the data provided in this builder.

Returns:

the new spec