1/*
2 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26/*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file:
31 *
32 * ASM: a very small and fast Java bytecode manipulation framework
33 * Copyright (c) 2000-2007 INRIA, France Telecom
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 * 3. Neither the name of the copyright holders nor the names of its
45 *    contributors may be used to endorse or promote products derived from
46 *    this software without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
49 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
52 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
53 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
54 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
55 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
56 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
57 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
58 * THE POSSIBILITY OF SUCH DAMAGE.
59 */
60package com.sun.xml.internal.ws.org.objectweb.asm;
61
62/**
63 * A visitor to visit a Java annotation. The methods of this interface must be
64 * called in the following order: (<tt>visit<tt> | <tt>visitEnum<tt> |
65 * <tt>visitAnnotation<tt> | <tt>visitArray<tt>)* <tt>visitEnd<tt>.
66 *
67 * @author Eric Bruneton
68 * @author Eugene Kuleshov
69 */
70public interface AnnotationVisitor {
71
72    /**
73     * Visits a primitive value of the annotation.
74     *
75     * @param name the value name.
76     * @param value the actual value, whose type must be {@link Byte},
77     *        {@link Boolean}, {@link Character}, {@link Short},
78     *        {@link Integer}, {@link Long}, {@link Float}, {@link Double},
79     *        {@link String} or {@link Type}. This value can also be an array
80     *        of byte, boolean, short, char, int, long, float or double values
81     *        (this is equivalent to using {@link #visitArray visitArray} and
82     *        visiting each array element in turn, but is more convenient).
83     */
84    void visit(String name, Object value);
85
86    /**
87     * Visits an enumeration value of the annotation.
88     *
89     * @param name the value name.
90     * @param desc the class descriptor of the enumeration class.
91     * @param value the actual enumeration value.
92     */
93    void visitEnum(String name, String desc, String value);
94
95    /**
96     * Visits a nested annotation value of the annotation.
97     *
98     * @param name the value name.
99     * @param desc the class descriptor of the nested annotation class.
100     * @return a visitor to visit the actual nested annotation value, or
101     *         <tt>null</tt> if this visitor is not interested in visiting
102     *         this nested annotation. <i>The nested annotation value must be
103     *         fully visited before calling other methods on this annotation
104     *         visitor</i>.
105     */
106    AnnotationVisitor visitAnnotation(String name, String desc);
107
108    /**
109     * Visits an array value of the annotation. Note that arrays of primitive
110     * types (such as byte, boolean, short, char, int, long, float or double)
111     * can be passed as value to {@link #visit visit}. This is what
112     * {@link ClassReader} does.
113     *
114     * @param name the value name.
115     * @return a visitor to visit the actual array value elements, or
116     *         <tt>null</tt> if this visitor is not interested in visiting
117     *         these values. The 'name' parameters passed to the methods of this
118     *         visitor are ignored. <i>All the array values must be visited
119     *         before calling other methods on this annotation visitor</i>.
120     */
121    AnnotationVisitor visitArray(String name);
122
123    /**
124     * Visits the end of the annotation.
125     */
126    void visitEnd();
127}
128