com.github.randomcodeorg.ppplugin.ppdefaults.logging

Class InsertCaughtExceptionLogProcessor

java.lang.Object

com.github.randomcodeorg.ppplugin.ppdefaults.AbstractClassModificationProcessor

com.github.randomcodeorg.ppplugin.ppdefaults.logging.AbstractLoggingProcessor

com.github.randomcodeorg.ppplugin.ppdefaults.logging.InsertCaughtExceptionLogProcessor

All Implemented Interfaces:

com.github.randomcodeorg.ppplugin.PProcessor

public abstract class InsertCaughtExceptionLogProcessor
extends AbstractLoggingProcessor

A processor that inserts log calls for every caught exception. To enable this processor create an inheriting class within your project.

Author:

Marcel Singer

Field Summary

Fields inherited from class com.github.randomcodeorg.ppplugin.ppdefaults.AbstractClassModificationProcessor

context

Constructor Summary

Constructors

Constructor and Description
InsertCaughtExceptionLogProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	doInsertCatchLog(java.lang.Class<?> clazz, javassist.expr.Handler h, javassist.CtBehavior behavior, javassist.CtField loggerField) Inserts the log call into the given catch-block.
protected LogLevel	getExceptionLogLevel(java.lang.Class<?> enclosingClass) Returns the LogLevel for caught exceptions (default is LogLevel.WARNING).
protected void	processClass(ByteCodeHelper helper, javassist.CtClass ctClass, java.lang.Class<?> runtimeClass) Processes the given class.

Methods inherited from class com.github.randomcodeorg.ppplugin.ppdefaults.logging.AbstractLoggingProcessor

getLoggerFieldPrefix, getLoggerInitialization, getLoggerType, getLogMethodName, injectLogger

Methods inherited from class com.github.randomcodeorg.ppplugin.ppdefaults.AbstractClassModificationProcessor

doRun, init, run

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertCaughtExceptionLogProcessor

public InsertCaughtExceptionLogProcessor()

Method Detail

processClass

protected void processClass(ByteCodeHelper helper,
                            javassist.CtClass ctClass,
                            java.lang.Class<?> runtimeClass)
                     throws javassist.CannotCompileException

Description copied from class: AbstractClassModificationProcessor

Processes the given class. Be sure to call ByteCodeHelper.edit(CtClass, Class) of the given helper if a class was edited. A call to ByteCodeHelper.commit() will be done automatically.

Specified by:

processClass in class AbstractClassModificationProcessor

Parameters:

helper - The ByteCodeHelper to be used.

ctClass - The javassist CtClass to process.

runtimeClass - The corresponding Class.

Throws:

javassist.CannotCompileException - If the changes could not be compiled.

doInsertCatchLog

protected void doInsertCatchLog(java.lang.Class<?> clazz,
                                javassist.expr.Handler h,
                                javassist.CtBehavior behavior,
                                javassist.CtField loggerField)
                         throws javassist.CannotCompileException

Inserts the log call into the given catch-block.

Parameters:

clazz - The class containing the given catch-block.

h - The handler representing the catch-block.

behavior - The method or constructor containing the catch-block.

loggerField - The field containing the logger instance.

Throws:

javassist.CannotCompileException - If the changes can not be compiled.

getExceptionLogLevel

protected LogLevel getExceptionLogLevel(java.lang.Class<?> enclosingClass)

Returns the LogLevel for caught exceptions (default is LogLevel.WARNING).

Parameters:

enclosingClass - The class in which the exception was caught.

Returns:

The LogLevel for caught exceptions.