com.sk89q.intake.parametric.handler

Interface InvokeHandler

All Known Implementing Classes:

LegacyCommandsHandler

public interface InvokeHandler

An invoke handler can be registered on a ParametricBuilder to listen in on commands being executed.

Invoke handlers have access to three different stages of command execution and can view the annotations, parameters, and arguments of the command. An invoke handler could be used to implement command logging, for example.

Method Summary

Modifier and Type	Method and Description
void	postInvoke(List<? extends Annotation> annotations, ArgumentParser parser, Object[] args, CommandArgs commandArgs) Called after the command has been executed.
boolean	preInvoke(List<? extends Annotation> annotations, ArgumentParser parser, Object[] args, CommandArgs commandArgs) Called after arguments have been parsed but the command has yet to be executed.
boolean	preProcess(List<? extends Annotation> annotations, ArgumentParser parser, CommandArgs commandArgs) Called before arguments have been parsed.

Method Detail

preProcess

boolean preProcess(List<? extends Annotation> annotations,
                   ArgumentParser parser,
                   CommandArgs commandArgs)
            throws CommandException,
                   ArgumentException

Called before arguments have been parsed.

Parameters:

annotations - The list of annotations on the command

parser - The argument parser with parameter information

commandArgs - The arguments provided by the user

Returns:

Whether command execution should continue

Throws:

CommandException - Thrown if there is a general command problem

ArgumentException - Thrown is there is an error with the arguments

preInvoke

boolean preInvoke(List<? extends Annotation> annotations,
                  ArgumentParser parser,
                  Object[] args,
                  CommandArgs commandArgs)
           throws CommandException,
                  ArgumentException

Called after arguments have been parsed but the command has yet to be executed.

Parameters:

annotations - The list of annotations on the command

parser - The argument parser with parameter information

args - The result of the parsed arguments: Java objects to be passed to the command

commandArgs - The arguments provided by the user

Returns:

Whether command execution should continue

Throws:

CommandException - Thrown if there is a general command problem

ArgumentException - Thrown is there is an error with the arguments

postInvoke

void postInvoke(List<? extends Annotation> annotations,
                ArgumentParser parser,
                Object[] args,
                CommandArgs commandArgs)
         throws CommandException,
                ArgumentException

Called after the command has been executed.

Parameters:

annotations - The list of annotations on the command

parser - The argument parser with parameter information

args - The result of the parsed arguments: Java objects to be passed to the command

commandArgs - The arguments provided by the user

Throws:

CommandException - Thrown if there is a general command problem

ArgumentException - Thrown is there is an error with the arguments