01: /*
02: * Spoon - http://spoon.gforge.inria.fr/
03: * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
04: *
05: * This software is governed by the CeCILL-C License under French law and
06: * abiding by the rules of distribution of free software. You can use, modify
07: * and/or redistribute the software under the terms of the CeCILL-C license as
08: * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
09: *
10: * This program is distributed in the hope that it will be useful, but WITHOUT
11: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12: * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
13: *
14: * The fact that you are presently reading this means that you have had
15: * knowledge of the CeCILL-C license and that you accept its terms.
16: */
17:
18: package spoon.processing;
19:
20: import java.lang.annotation.Annotation;
21: import java.util.Set;
22:
23: import spoon.reflect.declaration.CtElement;
24:
25: /**
26: * This interface defines an annotation processor. An annotation processor is
27: * triggered by Spoon when a visited element is annotated with one of the
28: * processed or consumed annotations. To define a new annotation processor, the
29: * user should subclass {@link spoon.processing.AbstractAnnotationProcessor},
30: * the abstract default implementation of this interface.
31: */
32: public interface AnnotationProcessor<A extends Annotation, E extends CtElement>
33: extends Processor<E> {
34:
35: /**
36: * Do the annotation processing job for a given annotation.
37: *
38: * @param annotation
39: * the annotation to process
40: * @param element
41: * the element that holds the processed annotations
42: */
43: void process(A annotation, E element);
44:
45: /**
46: * Gets the annotations processed by this annotation processor, that is to
47: * say the annotation types that trigger the
48: * {@link #process(Annotation, CtElement)} method when visiting a program
49: * element. The processed annotation types includes all the consumed
50: * annotation types.
51: *
52: * @return the annotation classes
53: */
54: Set<Class<? extends A>> getProcessedAnnotationTypes();
55:
56: /**
57: * Gets the annotations types consumed by this processor. A consumed
58: * annotation is a special kind of processed annotation (see
59: * {@link #getProcessedAnnotationTypes()} that is automatically removed from
60: * the program once the associated processor has finished its job.
61: *
62: * @return the annotation classes
63: */
64: Set<Class<? extends A>> getConsumedAnnotationTypes();
65:
66: /**
67: * Returns true (default) if the processor automatically infers the consumed
68: * annotation type to the <code>A</code> actual type.
69: */
70: boolean inferConsumedAnnotationType();
71:
72: }
|