javassist.build.IClassTransformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javassist-build-plugin-api Show documentation

A common interface for class transformers, java (or groovy) entities that can manipulate classes during build processes, right after javac compiled them.

The newest version!

package javassist.build;

import javassist.CtClass;

/**
 * A common interface to define class transformers, java (or groovy) 
 * entities that can manipulate classes during build processes, 
 * right after javac compiled them.
 * @author SNI
 */
public interface IClassTransformer {
    /**
     * Concrete implementations must implement all transformations on this method.
     * You can use Javassist API to add/remove/replace methods, attributes and more.
     * Only classes approved by {@link #shouldTransform(CtClass)} are considered.
     *
     * @param classToTransform The class to transform.
     * @see #filter(CtClass)
     * @throws JavassistBuildException if any error occur during the transformation.
     */
	void applyTransformations(CtClass ctClass) throws JavassistBuildException;
	
    /**
     * Test if the given class is suitable for applying transformations or not.
     * For example, if the class is a specific type:
     *      * CtClass myInterface = ClassPool.getDefault().get(MyInterface.class.getName());
     * return candidateClass.subtypeOf(myInterface);
     * 
     * Override this method to boost class transformations and discard classes you don't want
     * to transform.
     *
     * @param candidateClass
     * @return {@code true} if the Class should be transformed; {@code false} otherwise.
     * @throws JavassistBuildException if any error occur during filtering.
     */
	boolean shouldTransform(CtClass ctClass) throws JavassistBuildException;
}