net.sf.staccatocommons.instrument.handler.ClassAnnotationHandler Maven / Gradle / Ivy

Go to download
/**
 *  Copyright (c) 2010-2012, The StaccatoCommons Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation; version 3 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 */

package net.sf.staccatocommons.instrument.handler;

import java.lang.annotation.Annotation;

import javassist.CannotCompileException;
import javassist.NotFoundException;
import net.sf.staccatocommons.instrument.context.ClassAnnotationContext;
import net.sf.staccatocommons.restrictions.check.NonNull;

/**
 * 
 * Interface for annotation handlers that can process annotations in methods.
 * 
 * @author flbulgarelli
 * @param 
 *          the annotation type to handle
 */
public interface ClassAnnotationHandler extends AnnotationHandler {

  /**
   * Process an annotation discovered in a clazz by the
   * instrumenter, instrumenting the given context where the
   * annotation was found. This message is sent by the instrumenter before
   * discovering any method or constructor annotation.
   * 
   * @param annotation
   *          the annotation to process
   * @param context
   *          the instrumentable context where the annotation was found
   * @throws CannotCompileException
   *           if compilation errors occur during instrumentation
   * @throws NotFoundException
   *           if any type needed by instrumentation was not found
   */
  void preProcessAnnotatedClass(@NonNull A annotation, @NonNull ClassAnnotationContext context)
    throws CannotCompileException, NotFoundException;

  /**
   * Process an annotation discovered in a clazz by the
   * instrumenter, instrumenting the given context where the
   * annotation was found. This message is sent by the instrumenter after
   * discovering all methods and constructors annotations.
   * 
   * @param annotation
   *          the annotation to process
   * @param context
   *          the instrumentable context where the annotation was found
   * @throws CannotCompileException
   *           if compilation errors occur during instrumentation
   * @throws NotFoundException
   *           if any type needed by instrumentation was not found
   */
  void postProcessAnnotatedClass(@NonNull A annotation, @NonNull ClassAnnotationContext context)
    throws CannotCompileException, NotFoundException;

}