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(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.
void	updateDescription(Set<Annotation> annotations, ArgumentParser parser, ImmutableDescription.Builder builder) Called to update the description of a command.

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(List<? extends Annotation> annotations,
                          ArgumentParser parser,
                          CommandArgs commandArgs)
                   throws CommandException,
                          ArgumentException

Description copied from interface: InvokeHandler

Called before arguments have been parsed.

Specified by:

preProcess in interface InvokeHandler

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

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

Description copied from interface: InvokeHandler

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

Specified by:

preInvoke in interface InvokeHandler

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

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

Description copied from interface: InvokeHandler

Called after the command has been executed.

Specified by:

postInvoke in interface InvokeHandler

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

updateDescription

public void updateDescription(Set<Annotation> annotations,
                              ArgumentParser parser,
                              ImmutableDescription.Builder builder)

Description copied from interface: InvokeListener

Called to update the description of a command.

Specified by:

updateDescription in interface InvokeListener

Overrides:

updateDescription in class AbstractInvokeListener

Parameters:

annotations - Annotations on the command

parser - The parser containing parameter information

builder - The description builder