1 /*** 2 * ASM: a very small and fast Java bytecode manipulation framework 3 * Copyright (c) 2000-2005 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 */ 30 package org.objectweb.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 */ 40 public 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}. 50 */ 51 void visit(String name, Object value); 52 53 /** 54 * Visits an enumeration value of the annotation. 55 * 56 * @param name the value name. 57 * @param desc the class descriptor of the enumeration class. 58 * @param value the actual enumeration value. 59 */ 60 void visitEnum(String name, String desc, String value); 61 62 /** 63 * Visits a nested annotation value of the annotation. 64 * 65 * @param name the value name. 66 * @param desc the class descriptor of the nested annotation class. 67 * @return a non null visitor to visit the actual nested annotation value. 68 * <i>The nested annotation value must be fully visited before 69 * calling other methods on this annotation visitor</i>. 70 */ 71 AnnotationVisitor visitAnnotation(String name, String desc); 72 73 /** 74 * Visits an array value of the annotation. 75 * 76 * @param name the value name. 77 * @return a non null visitor to visit the actual array value elements. The 78 * 'name' parameters passed to the methods of this visitor are 79 * ignored. <i>All the array values must be visited before calling 80 * other methods on this annotation visitor</i>. 81 */ 82 AnnotationVisitor visitArray(String name); 83 84 /** 85 * Visits the end of the annotation. 86 */ 87 void visitEnd(); 88 } 89
