com.sk89q.intake.parametric.handler

Class LegacyCommandsHandler

java.lang.Object

com.sk89q.intake.parametric.handler.AbstractInvokeListener

com.sk89q.intake.parametric.handler.LegacyCommandsHandler

All Implemented Interfaces:

InvokeHandler, InvokeListener

public class LegacyCommandsHandler
extends AbstractInvokeListener
implements InvokeHandler

Handles legacy properties on Command such as Command.min() and Command.max().

Constructor Summary

Constructors

Constructor and Description
LegacyCommandsHandler()

Method Summary

Modifier and Type	Method and Description
InvokeHandler	createInvokeHandler() Create a new invocation handler.
void	postInvoke(Set<Annotation> annotations, List<? extends ParameterData<?>> parameters, Object[] args, CommandContext context) Called after the parameter is invoked.
boolean	preInvoke(Set<Annotation> annotations, List<? extends ParameterData<?>> parameters, Object[] args, CommandContext context) Called before the parameter is invoked.
boolean	preProcess(Set<Annotation> annotations, List<? extends ParameterData<?>> parameters, CommandContext context) Called before parameters are processed.
void	updateDescription(Set<Annotation> annotations, List<? extends ParameterData<?>> parameters, SettableDescription description) During creation of a CommandCallable by a ParametricBuilder, this will be called in case the description needs to be updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyCommandsHandler

public LegacyCommandsHandler()

Method Detail

createInvokeHandler

public InvokeHandler createInvokeHandler()

Description copied from interface: InvokeListener

Create a new invocation handler.

An example use of an InvokeHandler would be to verify permissions added by the Require annotation.

For simple InvokeHandler, an object can implement both this interface and InvokeHandler.

Specified by:

createInvokeHandler in interface InvokeListener

Returns:

a new invocation handler

preProcess

public boolean preProcess(Set<Annotation> annotations,
                          List<? extends ParameterData<?>> parameters,
                          CommandContext context)
                   throws CommandException,
                          ParameterException

Description copied from interface: InvokeHandler

Called before parameters are processed.

Specified by:

preProcess in interface InvokeHandler

Parameters:

annotations - set of annotations that apply to the command

parameters - the list of parameters

context - the context

Throws:

CommandException - can be thrown for an error, which will stop invocation

ParameterException - on parameter error

preInvoke

public boolean preInvoke(Set<Annotation> annotations,
                         List<? extends ParameterData<?>> parameters,
                         Object[] args,
                         CommandContext context)
                  throws ParameterException,
                         UnconsumedParameterException

Description copied from interface: InvokeHandler

Called before the parameter is invoked.

Specified by:

preInvoke in interface InvokeHandler

Parameters:

annotations - set of annotations that apply to the command

parameters - the list of parameters

args - the arguments to be given to the method

context - the context

Returns:

true to permit invocation of command

Throws:

ParameterException - on parameter error

UnconsumedParameterException

postInvoke

public void postInvoke(Set<Annotation> annotations,
                       List<? extends ParameterData<?>> parameters,
                       Object[] args,
                       CommandContext context)

Description copied from interface: InvokeHandler

Called after the parameter is invoked.

Specified by:

postInvoke in interface InvokeHandler

Parameters:

annotations - set of annotations that apply to the command

parameters - the list of parameters

args - the arguments to be given to the method

context - the context

updateDescription

public void updateDescription(Set<Annotation> annotations,
                              List<? extends ParameterData<?>> parameters,
                              SettableDescription description)

Description copied from interface: InvokeListener

During creation of a CommandCallable by a ParametricBuilder, this will be called in case the description needs to be updated.

Specified by:

updateDescription in interface InvokeListener

Overrides:

updateDescription in class AbstractInvokeListener

Parameters:

annotations - the annotations on the command

parameters - a list of parameters

description - the description to be updated