CoverageClassAdapter.java

package com.ikokoon.serenity.instrumentation.coverage;

import org.apache.log4j.Logger;
import org.objectweb.asm.ClassAdapter;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.MethodAdapter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

import com.ikokoon.serenity.instrumentation.VisitorFactory;
import com.ikokoon.toolkit.Toolkit;

/**
 * This is the class visitor that visits the class structures and invokes the method visitor for the coverage functionality.
 *
 * @author Michael Couck
 * @since 12.07.09
 * @version 01.00
 */
public class CoverageClassAdapter extends ClassAdapter implements Opcodes {

	private Logger logger = Logger.getLogger(this.getClass());
	/** The name of the class that is being instrumented. */
	private String className;

	/**
	 * Constructs a {@link CoverageClassAdapter} that takes the parent class visitor and the class name that will be enhanced with instructions to
	 * invoke the {@link com.ikokoon.serenity.Collector} that collects the instructions that are executed.
	 *
	 * @param visitor
	 *            the parent class visitor
	 * @param className
	 *            that name of the class that will be enhanced with coverage instructions
	 */
	public CoverageClassAdapter(ClassVisitor visitor, String className) {
		super(visitor);
		this.className = Toolkit.slashToDot(className);
		logger.debug("Constructor : " + className);
	}

	/**
	 * This is the method that calls the MethodAdapter that will enhance the class methods with instructions that will enable data to be collected for
	 * the class at runtime producing a line coverage report for the class.
	 */
	public MethodVisitor visitMethod(int access, String methodName, String methodDescription, String methodSignature, String[] exceptions) {
		logger.debug("visitMethod : " + access + ", " + methodName + ", " + methodDescription + ", " + methodSignature + ", " + exceptions);
		MethodVisitor methodVisitor = super.visitMethod(access, methodName, methodDescription, methodSignature, exceptions);
		MethodAdapter methodAdapter = (MethodAdapter) VisitorFactory.getMethodVisitor(methodVisitor, CoverageMethodAdapter.class, access, className,
				methodName, methodDescription);
		return methodAdapter;
	}

}