com.github.randomcodeorg.ppplugin.ppdefaults.logging

Class AbstractLoggingProcessor

java.lang.Object

com.github.randomcodeorg.ppplugin.ppdefaults.AbstractClassModificationProcessor

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

All Implemented Interfaces:

com.github.randomcodeorg.ppplugin.PProcessor

Direct Known Subclasses:

InsertCaughtExceptionLogProcessor, InsertMethodCallLogProcessor

public abstract class AbstractLoggingProcessor
extends AbstractClassModificationProcessor

A processor that can be inherited to insert logging calls. One can/should override the methods of this processor to modify/customize the way the logger is called.

Author:

Marcel Singer

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
AbstractLoggingProcessor() Creates a new instance of AbstractLoggingProcessor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getLoggerFieldPrefix() Returns the prefix of the field that will be created to hold the logger.
protected java.lang.String	getLoggerInitialization(javassist.CtClass cl) Returns the initial value of the logger.
protected java.lang.String	getLoggerType() Returns the canonical name of the loggers class.
protected java.lang.String	getLogMethodName(LogLevel level) Returns the name of the loggers log method.
protected javassist.CtField	injectLogger(ByteCodeHelper helper, javassist.CtClass ctClass) Creates the field that holds the logger for the given class.

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

doRun, init, processClass, run

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLoggingProcessor

public AbstractLoggingProcessor()

Creates a new instance of AbstractLoggingProcessor.

Method Detail

getLogMethodName

protected java.lang.String getLogMethodName(LogLevel level)

Returns the name of the loggers log method.

Parameters:

level - The log level.

Returns:

the name of the loggers log method (e.g. "info", "warn").

getLoggerType

protected java.lang.String getLoggerType()

Returns the canonical name of the loggers class.

Note: The class of the logger must be available during the compilation (e.g. included as a maven dependency).

Returns:

The canonical name of the loggers class (e.g. "org.slf4j.Logger").

getLoggerFieldPrefix

protected java.lang.String getLoggerFieldPrefix()

Returns the prefix of the field that will be created to hold the logger.

Returns:

The prefix of the field that will be created to hold the logger.

getLoggerInitialization

protected java.lang.String getLoggerInitialization(javassist.CtClass cl)

Returns the initial value of the logger.

Parameters:

cl - The class in which the logger will be used.

Returns:

The initial value of the logger (e.g. "new Logger()", "org.slf4j.LoggerFactory.getLogger(Object.class)").

injectLogger

protected javassist.CtField injectLogger(ByteCodeHelper helper,
                                         javassist.CtClass ctClass)
                                  throws javassist.CannotCompileException

Creates the field that holds the logger for the given class.

Parameters:

helper - The helper to be used.

ctClass - The class in which the logger will be used.

Returns:

The field that holds the logger for the given class.

Throws:

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