net.sf.staccatocommons.instrument.handler.AnnotationHandler 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 net.sf.staccatocommons.restrictions.check.NonNull;

/**
 * Superinterface for all annotation handlers.
 * 
 * Although a concrete handler may implement more than one
 * handler interfaces, in order to be capable of processing more than one
 * element type, this interface reinforce that a handler must
 * process a single annotation type
 * 
 * 
 * As instrumentation is performed on a single thread, {@link AnnotationHandler}
 * s have no restrictions regarding synchronization. In particular, they do not
 * need to be statless nor immutable.
 * 
 * This interface must not be implemented directly by client
 * code. It must implement one of the subinterfaces from this
 * package
 * 
 * @author flbulgarelli
 * @see ArgumentAnnotationHandler
 * @see MethodAnnotationHandler
 * @see ConstructorAnnotationHandler
 * @see ClassAnnotationHandler
 * 
 */
public interface AnnotationHandler {

  /**
   * Answers the annotation this processor can process
   * 
   * @return an annotation type
   */
  @NonNull
  Class getSupportedAnnotationType();

}