AnnotationVisitor.java revision 674060f01e9090cd21b3c5656cc3204912ad17a6 
1/***
2 * ASM: a very small and fast Java bytecode manipulation framework
3 * Copyright (c) 2000-2007 INRIA, France Telecom
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 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 */
30package org.mockito.asm;
31
32/**
33 * A visitor to visit a Java annotation. The methods of this interface must be
34 * called in the following order: (<tt>visit<tt> | <tt>visitEnum<tt> |
35 * <tt>visitAnnotation<tt> | <tt>visitArray<tt>)* <tt>visitEnd<tt>.
36 *
37 * @author Eric Bruneton
38 * @author Eugene Kuleshov
39 */
40public interface AnnotationVisitor {
41
42    /**
43     * Visits a primitive value of the annotation.
44     *
45     * @param name the value name.
46     * @param value the actual value, whose type must be {@link Byte},
47     *        {@link Boolean}, {@link Character}, {@link Short},
48     *        {@link Integer}, {@link Long}, {@link Float}, {@link Double},
49     *        {@link String} or {@link Type}. This value can also be an array
50     *        of byte, boolean, short, char, int, long, float or double values
51     *        (this is equivalent to using {@link #visitArray visitArray} and
52     *        visiting each array element in turn, but is more convenient).
53     */
54    void visit(String name, Object value);
55
56    /**
57     * Visits an enumeration value of the annotation.
58     *
59     * @param name the value name.
60     * @param desc the class descriptor of the enumeration class.
61     * @param value the actual enumeration value.
62     */
63    void visitEnum(String name, String desc, String value);
64
65    /**
66     * Visits a nested annotation value of the annotation.
67     *
68     * @param name the value name.
69     * @param desc the class descriptor of the nested annotation class.
70     * @return a visitor to visit the actual nested annotation value, or
71     *         <tt>null</tt> if this visitor is not interested in visiting
72     *         this nested annotation. <i>The nested annotation value must be
73     *         fully visited before calling other methods on this annotation
74     *         visitor</i>.
75     */
76    AnnotationVisitor visitAnnotation(String name, String desc);
77
78    /**
79     * Visits an array value of the annotation. Note that arrays of primitive
80     * types (such as byte, boolean, short, char, int, long, float or double)
81     * can be passed as value to {@link #visit visit}. This is what
82     * {@link ClassReader} does.
83     *
84     * @param name the value name.
85     * @return a visitor to visit the actual array value elements, or
86     *         <tt>null</tt> if this visitor is not interested in visiting
87     *         these values. The 'name' parameters passed to the methods of this
88     *         visitor are ignored. <i>All the array values must be visited
89     *         before calling other methods on this annotation visitor</i>.
90     */
91    AnnotationVisitor visitArray(String name);
92
93    /**
94     * Visits the end of the annotation.
95     */
96    void visitEnd();
97}
98