com.sk89q.intake.parametric

Class AbstractParametricCommand

java.lang.Object

com.sk89q.intake.parametric.AbstractParametricCommand

All Implemented Interfaces:

CommandCallable, CommandCompleter

public abstract class AbstractParametricCommand
extends Object
implements CommandCallable

An abstract implementation of CommandCallable that does everything but the actual parameter binding and method calling.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractParametricCommand(ParametricBuilder builder) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract void	call(Object[] args) Called with parsed arguments.
boolean	call(String stringArguments, CommandLocals locals, String[] parentCommands) Execute the correct command based on the input.
com.google.common.collect.ImmutableSet<Annotation>	getAnnotations() Get the annotations that describe the command.
protected ParametricBuilder	getBuilder() Get the instance of the parametric builder.
protected boolean	getIgnoreUnusedFlags() Get whether unused flags should be ignored (and therefore not cause an exception to be thrown).
protected List<? extends ParameterData<?>>	getParameters() Get the parameters that have been set.
protected List<String>	getPermissions() Get the parameters.
List<String>	getSuggestions(String arguments, CommandLocals locals) Get a list of suggestions based on input.
protected Set<Character>	getUnusedFlags() Get the list of flags that can be unused when parsing arguments.
protected Set<Character>	getValueFlags() Get the value flags.
void	setAnnotations(Set<Annotation> annotations) Set the annotations that describe the command.
protected void	setIgnoreUnusedFlags(boolean ignoreUnusedFlags) Set whether unused flags should be ignored (and therefore not cause an exception to be thrown).
protected void	setParameters(List<? extends ParameterData<?>> parameters) Set the parameters that have been set.
protected void	setPermissions(List<String> permissions) Set the list of permissions, one of which must be met.
protected void	setUnusedFlags(Set<Character> unusedFlags) Set the list of flags that can be unused when parsing arguments.
protected void	setValueFlags(Set<Character> valueFlags)
boolean	testPermission(CommandLocals locals) Test whether this command can be executed with the given context.

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

Constructor Detail

AbstractParametricCommand

protected AbstractParametricCommand(ParametricBuilder builder)

Create a new instance.

Parameters:

builder - the builder

Method Detail

getBuilder

protected ParametricBuilder getBuilder()

Get the instance of the parametric builder.

Returns:

the parametric builder

getParameters

protected List<? extends ParameterData<?>> getParameters()

Get the parameters that have been set.

Returns:

the parameters

getPermissions

protected List<String> getPermissions()

Get the parameters.

Returns:

the parameters

setParameters

protected void setParameters(List<? extends ParameterData<?>> parameters)

Set the parameters that have been set.

Parameters:

parameters - the parameters

setPermissions

protected void setPermissions(List<String> permissions)

Set the list of permissions, one of which must be met.

Parameters:

permissions - the permissions

getValueFlags

protected Set<Character> getValueFlags()

Get the value flags.

Returns:

the value flags

setValueFlags

protected void setValueFlags(Set<Character> valueFlags)

getIgnoreUnusedFlags

protected boolean getIgnoreUnusedFlags()

Get whether unused flags should be ignored (and therefore not cause an exception to be thrown).

Returns:

true if unused flags are to be ignored

setIgnoreUnusedFlags

protected void setIgnoreUnusedFlags(boolean ignoreUnusedFlags)

Set whether unused flags should be ignored (and therefore not cause an exception to be thrown).

Parameters:

ignoreUnusedFlags - true if unused flags are to be ignored

getUnusedFlags

protected Set<Character> getUnusedFlags()

Get the list of flags that can be unused when parsing arguments.

Returns:

list of flags

setUnusedFlags

protected void setUnusedFlags(Set<Character> unusedFlags)

Set the list of flags that can be unused when parsing arguments.

Parameters:

unusedFlags - list of flags

getAnnotations

public com.google.common.collect.ImmutableSet<Annotation> getAnnotations()

Get the annotations that describe the command.

Returns:

the annotations

setAnnotations

public void setAnnotations(Set<Annotation> annotations)

Set the annotations that describe the command.

Parameters:

annotations - the annotations

call

public final boolean call(String stringArguments,
                          CommandLocals locals,
                          String[] parentCommands)
                   throws CommandException,
                          AuthorizationException

Description copied from interface: CommandCallable

Execute the correct command based on the input.

The implementing class must perform the necessary permission checks.

Specified by:

call in interface CommandCallable

Parameters:

stringArguments - the arguments

locals - the locals

parentCommands - a list of parent commands, with the first most entry being the top-level command

Returns:

the called command, or null if there was no command found

Throws:

CommandException - thrown on a command error

AuthorizationException

call

protected abstract void call(Object[] args)
                      throws Exception

Called with parsed arguments.

Parameters:

args - the parsed arguments

Throws:

Exception - on any error

testPermission

public boolean testPermission(CommandLocals locals)

Description copied from interface: CommandCallable

Test whether this command can be executed with the given context.

Specified by:

testPermission in interface CommandCallable

Parameters:

locals - the locals

Returns:

true if execution is permitted

getSuggestions

public List<String> getSuggestions(String arguments,
                                   CommandLocals 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