com.sk89q.intake.parametric.handler

Interface InvokeHandler

All Known Implementing Classes:

LegacyCommandsHandler

public interface InvokeHandler

Called before and after a command is invoked for commands executed by a command created with ParametricBuilder.

Invocation handlers are created by InvokeListeners. Multiple listeners and handlers can be registered, and all be run. However, if one handler throws an exception, future handlers will not execute and the command will not execute (if thrown in preInvoke(Set, List, Object[], CommandContext).

See Also:

the factory

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

preProcess

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

Called before parameters are processed.

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

UnconsumedParameterException

preInvoke

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

Called before the parameter is invoked.

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:

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

ParameterException - on parameter error

UnconsumedParameterException

postInvoke

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

Called after the parameter is invoked.

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

Throws:

CommandException - can be thrown for an error

ParameterException - on parameter error

UnconsumedParameterException