01: /***
02: * ASM: a very small and fast Java bytecode manipulation framework
03: * Copyright (c) 2000-2005 INRIA, France Telecom
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions
08: * are met:
09: * 1. Redistributions of source code must retain the above copyright
10: * notice, this list of conditions and the following disclaimer.
11: * 2. Redistributions in binary form must reproduce the above copyright
12: * notice, this list of conditions and the following disclaimer in the
13: * documentation and/or other materials provided with the distribution.
14: * 3. Neither the name of the copyright holders nor the names of its
15: * contributors may be used to endorse or promote products derived from
16: * this software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28: * THE POSSIBILITY OF SUCH DAMAGE.
29: */package com.tc.asm;
30:
31: /**
32: * A visitor to visit a Java annotation. The methods of this interface must be
33: * called in the following order: (<tt>visit<tt> | <tt>visitEnum<tt> |
34: * <tt>visitAnnotation<tt> | <tt>visitArray<tt>)* <tt>visitEnd<tt>.
35: *
36: * @author Eric Bruneton
37: * @author Eugene Kuleshov
38: */
39: public interface AnnotationVisitor {
40:
41: /**
42: * Visits a primitive value of the annotation.
43: *
44: * @param name the value name.
45: * @param value the actual value, whose type must be {@link Byte},
46: * {@link Boolean}, {@link Character}, {@link Short},
47: * {@link Integer}, {@link Long}, {@link Float}, {@link Double},
48: * {@link String} or {@link Type}. This value can also be an array
49: * of byte, boolean, short, char, int, long, float or double values
50: * (this is equivalent to using {@link #visitArray visitArray} and
51: * visiting each array element in turn, but is more convenient).
52: */
53: void visit(String name, Object value);
54:
55: /**
56: * Visits an enumeration value of the annotation.
57: *
58: * @param name the value name.
59: * @param desc the class descriptor of the enumeration class.
60: * @param value the actual enumeration value.
61: */
62: void visitEnum(String name, String desc, String value);
63:
64: /**
65: * Visits a nested annotation value of the annotation.
66: *
67: * @param name the value name.
68: * @param desc the class descriptor of the nested annotation class.
69: * @return a visitor to visit the actual nested annotation value, or
70: * <tt>null</tt> if this visitor is not interested in visiting
71: * this nested annotation. <i>The nested annotation value must be
72: * fully visited before calling other methods on this annotation
73: * visitor</i>.
74: */
75: AnnotationVisitor visitAnnotation(String name, String desc);
76:
77: /**
78: * Visits an array value of the annotation. Note that arrays of primitive
79: * types (such as byte, boolean, short, char, int, long, float or double)
80: * can be passed as value to {@link #visit visit}. This is what
81: * {@link ClassReader} does.
82: *
83: * @param name the value name.
84: * @return a visitor to visit the actual array value elements, or
85: * <tt>null</tt> if this visitor is not interested in visiting
86: * these values. The 'name' parameters passed to the methods of this
87: * visitor are ignored. <i>All the array values must be visited
88: * before calling other methods on this annotation visitor</i>.
89: */
90: AnnotationVisitor visitArray(String name);
91:
92: /**
93: * Visits the end of the annotation.
94: */
95: void visitEnd();
96: }
|