01: package org.objectweb.celtix.common.annotation;
02:
03: import java.lang.annotation.Annotation;
04: import java.lang.reflect.Field;
05: import java.lang.reflect.Method;
06: import java.util.List;
07:
08: /** Visits the annotated elements of an object
09: *
10: */
11: public interface AnnotationVisitor {
12:
13: /** set the target object being visited. Invoked before any of
14: * the visit methods.
15: *
16: * @see AnnotationProcessor
17: *
18: * @param target the target object
19: */
20: void setTarget(Object target);
21:
22: /** return the list of annotations this visitor wants to be
23: * informed about.
24: *
25: * @return list of annotation types to be informed about
26: *
27: */
28: List<Class<? extends Annotation>> getTargetAnnotations();
29:
30: /** visit an annotated class. Invoked when the class of an object
31: * is annotated by one of the specified annotations.
32: * <code>visitClass</code> is called for each of the annotations
33: * that matches and for each class.
34: *
35: * @param clz the class with the annotation
36: * @param annotation the annotation
37: *
38: */
39: void visitClass(Class<?> clz, Annotation annotation);
40:
41: /** visit an annotated field. Invoked when the field of an object
42: * is annotated by one of the specified annotations.
43: * <code>visitField</code> is called for each of the annotations
44: * that matches and for each field.
45: *
46: * @param field the annotated field
47: * @param annotation the annotation
48: *
49: */
50: void visitField(Field field, Annotation annotation);
51:
52: /** visit an annotated method. Invoked when the method of an object
53: * is annotated by one of the specified annotations.
54: * <code>visitMethod</code> is called for each of the annotations
55: * that matches and for each method.
56: *
57: * @param method the annotated fieldx
58: * @param annotation the annotation
59: *
60: */
61: void visitMethod(Method method, Annotation annotation);
62: }
|