com.github.randomcodeorg.ppplugin.ppdefaults

Class AbstractClassModificationProcessor

java.lang.Object

com.github.randomcodeorg.ppplugin.ppdefaults.AbstractClassModificationProcessor

All Implemented Interfaces:

com.github.randomcodeorg.ppplugin.PProcessor

Direct Known Subclasses:

AbstractLoggingProcessor

public abstract class AbstractClassModificationProcessor
extends java.lang.Object
implements com.github.randomcodeorg.ppplugin.PProcessor

A processor that iterates over all compiled classes. You can inherit from this processor to modify such classes.

Author:

Marcel Singer

Field Summary

Fields

Modifier and Type	Field and Description
protected com.github.randomcodeorg.ppplugin.PContext	context The context of this processor.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	doRun() Iterates over all compiled classes and calls processClass(ByteCodeHelper, CtClass, Class).
void	init(com.github.randomcodeorg.ppplugin.PContext context)
protected abstract void	processClass(ByteCodeHelper helper, javassist.CtClass ctClass, java.lang.Class<?> clazz) Processes the given class.
void	run(com.github.randomcodeorg.ppplugin.PContext context)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected com.github.randomcodeorg.ppplugin.PContext context

The context of this processor.

Constructor Detail

AbstractClassModificationProcessor

public AbstractClassModificationProcessor()

Creates a new instance of AbstractClassModificationProcessor.

Method Detail

init

public void init(com.github.randomcodeorg.ppplugin.PContext context)

Specified by:

init in interface com.github.randomcodeorg.ppplugin.PProcessor

run

public void run(com.github.randomcodeorg.ppplugin.PContext context)

Specified by:

run in interface com.github.randomcodeorg.ppplugin.PProcessor

doRun

protected void doRun()
              throws javassist.NotFoundException

Iterates over all compiled classes and calls processClass(ByteCodeHelper, CtClass, Class).

Throws:

javassist.NotFoundException - Is thrown if the javassist ClassPool could not be created.

processClass

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

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.

Parameters:

helper - The ByteCodeHelper to be used.

ctClass - The javassist CtClass to process.

clazz - The corresponding Class.

Throws:

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