com.sk89q.worldedit.internal.command

Class CommandLoggingHandler

java.lang.Object

com.sk89q.worldedit.util.command.parametric.AbstractInvokeListener

com.sk89q.worldedit.internal.command.CommandLoggingHandler

All Implemented Interfaces:

InvokeHandler, InvokeListener, Closeable, AutoCloseable

public class CommandLoggingHandler
extends AbstractInvokeListener
implements InvokeHandler, Closeable

Logs called commands to a logger.

Constructor Summary

Constructors

Constructor and Description
CommandLoggingHandler(WorldEdit worldEdit, Logger logger) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
InvokeHandler	createInvokeHandler() Create a new invocation handler.
void	postInvoke(Object object, Method method, ParameterData[] parameters, Object[] args, CommandContext context) Called after the parameter is invoked.
void	preInvoke(Object object, Method method, ParameterData[] parameters, Object[] args, CommandContext context) Called before the parameter is invoked.
void	preProcess(Object object, Method method, ParameterData[] parameters, CommandContext context) Called before parameters are processed.

Methods inherited from class com.sk89q.worldedit.util.command.parametric.AbstractInvokeListener

updateDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLoggingHandler

public CommandLoggingHandler(WorldEdit worldEdit,
                             Logger logger)

Create a new instance.

Parameters:

worldEdit - an instance of WorldEdit

logger - the logger to send messages to

Method Detail

preProcess

public void preProcess(Object object,
                       Method method,
                       ParameterData[] parameters,
                       CommandContext context)
                throws CommandException,
                       ParameterException

Description copied from interface: InvokeHandler

Called before parameters are processed.

Specified by:

preProcess in interface InvokeHandler

Parameters:

object - the object

method - the method

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 void preInvoke(Object object,
                      Method method,
                      ParameterData[] parameters,
                      Object[] args,
                      CommandContext context)
               throws CommandException

Description copied from interface: InvokeHandler

Called before the parameter is invoked.

Specified by:

preInvoke in interface InvokeHandler

Parameters:

object - the object

method - the method

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, which will stop invocation

postInvoke

public void postInvoke(Object object,
                       Method method,
                       ParameterData[] parameters,
                       Object[] args,
                       CommandContext context)
                throws CommandException

Description copied from interface: InvokeHandler

Called after the parameter is invoked.

Specified by:

postInvoke in interface InvokeHandler

Parameters:

object - the object

method - the method

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

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 CommandPermissions annotation.

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

Specified by:

createInvokeHandler in interface InvokeListener

Returns:

a new invocation handler

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable