com.sk89q.intake.parametric

Class AbstractParametricCallable

java.lang.Object

com.sk89q.intake.parametric.AbstractParametricCallable

All Implemented Interfaces:

CommandCallable, CommandCompleter

public abstract class AbstractParametricCallable
extends Object
implements CommandCallable

A base class for commands that use ArgumentParser.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractParametricCallable(ParametricBuilder builder, ArgumentParser parser) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract void	call(Object[] args) Called with parsed arguments to execute the command.
boolean	call(String stringArguments, Namespace namespace, List<String> parentCommands) Execute the command.
protected ParametricBuilder	getBuilder() Get the parametric builder.
protected List<? extends Annotation>	getCommandAnnotations() Get the annotations on the command.
protected ArgumentParser	getParser() Get the argument parser.
List<String>	getSuggestions(String arguments, Namespace locals) Get a list of suggestions based on input.
protected Set<Character>	getUnusedFlags() Get a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.
protected boolean	isIgnoreUnusedFlags() Get whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.
protected void	setCommandAnnotations(List<? extends Annotation> commandAnnotations) Set the annotations on the command.
protected void	setIgnoreUnusedFlags(boolean ignoreUnusedFlags) Set whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.
protected void	setUnusedFlags(Set<Character> unusedFlags) Set a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.intake.CommandCallable

getDescription, testPermission

Constructor Detail

AbstractParametricCallable

protected AbstractParametricCallable(ParametricBuilder builder,
                                     ArgumentParser parser)

Create a new instance.

Parameters:

builder - An instance of the parametric builder

parser - The argument parser

Method Detail

getBuilder

protected ParametricBuilder getBuilder()

Get the parametric builder.

Returns:

The parametric builder

getParser

protected ArgumentParser getParser()

Get the argument parser.

Returns:

The argument parser

getCommandAnnotations

protected List<? extends Annotation> getCommandAnnotations()

Get the annotations on the command.

Returns:

The annotations on the command

setCommandAnnotations

protected void setCommandAnnotations(List<? extends Annotation> commandAnnotations)

Set the annotations on the command.

Parameters:

commandAnnotations - The annotations on the command

isIgnoreUnusedFlags

protected boolean isIgnoreUnusedFlags()

Get whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.

Returns:

Whether unused flags should be ignored

setIgnoreUnusedFlags

protected void setIgnoreUnusedFlags(boolean ignoreUnusedFlags)

Set whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.

Parameters:

ignoreUnusedFlags - Whether unused flags should be ignored

getUnusedFlags

protected Set<Character> getUnusedFlags()

Get a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.

Returns:

List of flags that can be unconsumed

setUnusedFlags

protected void setUnusedFlags(Set<Character> unusedFlags)

Set a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.

Parameters:

unusedFlags - List of flags that can be unconsumed

call

public final boolean call(String stringArguments,
                          Namespace namespace,
                          List<String> parentCommands)
                   throws CommandException,
                          InvocationCommandException,
                          AuthorizationException

Description copied from interface: CommandCallable

Execute the command.

parentCommands is a list of "parent" commands, including the current command, where each deeper command is appended to the list of parent commands.

For example, if the command entered was /world create ocean and the command in question was the "create" command, then:

• arguments would be ocean
• parentCommands would be world create

On the other hand, if the command was "world," then:

• arguments would be create ocean
• parentCommands would be world

Specified by:

call in interface CommandCallable

Parameters:

stringArguments - The arguments

namespace - Additional values used for execution

parentCommands - The list of parent commands

Returns:

Whether the command succeeded

Throws:

CommandException - If there is an error with the command

InvocationCommandException - If there is an error with executing the command

AuthorizationException - If there is a authorization error

call

protected abstract void call(Object[] args)
                      throws CommandException,
                             InvocationCommandException

Called with parsed arguments to execute the command.

Parameters:

args - The arguments parsed into the appropriate Java objects

Throws:

CommandException - Thrown on a command error

InvocationCommandException - Thrown on an error executing the command

getSuggestions

public List<String> getSuggestions(String arguments,
                                   Namespace locals)
                            throws CommandException

Description copied from interface: CommandCompleter

Get a list of suggestions based on input.

Specified by:

getSuggestions in interface CommandCompleter

Parameters:

arguments - the arguments entered up to this point

locals - the locals

Returns:

a list of suggestions

Throws:

CommandException - thrown if there was a parsing error