|
| 1 | +// ASM: a very small and fast Java bytecode manipulation framework |
| 2 | +// Copyright (c) 2000-2011 INRIA, France Telecom |
| 3 | +// All rights reserved. |
| 4 | +// |
| 5 | +// Redistribution and use in source and binary forms, with or without |
| 6 | +// modification, are permitted provided that the following conditions |
| 7 | +// are met: |
| 8 | +// 1. Redistributions of source code must retain the above copyright |
| 9 | +// notice, this list of conditions and the following disclaimer. |
| 10 | +// 2. Redistributions in binary form must reproduce the above copyright |
| 11 | +// notice, this list of conditions and the following disclaimer in the |
| 12 | +// documentation and/or other materials provided with the distribution. |
| 13 | +// 3. Neither the name of the copyright holders nor the names of its |
| 14 | +// contributors may be used to endorse or promote products derived from |
| 15 | +// this software without specific prior written permission. |
| 16 | +// |
| 17 | +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 18 | +// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 19 | +// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 20 | +// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| 21 | +// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 22 | +// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 23 | +// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 24 | +// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 25 | +// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 26 | +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| 27 | +// THE POSSIBILITY OF SUCH DAMAGE. |
| 28 | +package saker.java.testing.agent.thirdparty.org.objectweb.asm; |
| 29 | + |
| 30 | +/** |
| 31 | + * A visitor to visit a Java annotation. The methods of this class must be called in the following |
| 32 | + * order: ( {@code visit} | {@code visitEnum} | {@code visitAnnotation} | {@code visitArray} )* |
| 33 | + * {@code visitEnd}. |
| 34 | + * |
| 35 | + * @author Eric Bruneton |
| 36 | + * @author Eugene Kuleshov |
| 37 | + */ |
| 38 | +public abstract class AnnotationVisitor { |
| 39 | + |
| 40 | + /** |
| 41 | + * The ASM API version implemented by this visitor. The value of this field must be one of {@link |
| 42 | + * Opcodes#ASM4}, {@link Opcodes#ASM5}, {@link Opcodes#ASM6} or {@link Opcodes#ASM7}. |
| 43 | + */ |
| 44 | + protected final int api; |
| 45 | + |
| 46 | + /** |
| 47 | + * The annotation visitor to which this visitor must delegate method calls. May be {@literal |
| 48 | + * null}. |
| 49 | + */ |
| 50 | + protected AnnotationVisitor av; |
| 51 | + |
| 52 | + /** |
| 53 | + * Constructs a new {@link AnnotationVisitor}. |
| 54 | + * |
| 55 | + * @param api the ASM API version implemented by this visitor. Must be one of {@link |
| 56 | + * Opcodes#ASM4}, {@link Opcodes#ASM5}, {@link Opcodes#ASM6} or {@link Opcodes#ASM7}. |
| 57 | + */ |
| 58 | + public AnnotationVisitor(final int api) { |
| 59 | + this(api, null); |
| 60 | + } |
| 61 | + |
| 62 | + /** |
| 63 | + * Constructs a new {@link AnnotationVisitor}. |
| 64 | + * |
| 65 | + * @param api the ASM API version implemented by this visitor. Must be one of {@link |
| 66 | + * Opcodes#ASM4}, {@link Opcodes#ASM5}, {@link Opcodes#ASM6} or {@link Opcodes#ASM7}. |
| 67 | + * @param annotationVisitor the annotation visitor to which this visitor must delegate method |
| 68 | + * calls. May be {@literal null}. |
| 69 | + */ |
| 70 | + public AnnotationVisitor(final int api, final AnnotationVisitor annotationVisitor) { |
| 71 | + if (api != Opcodes.ASM7 |
| 72 | + && api != Opcodes.ASM6 |
| 73 | + && api != Opcodes.ASM5 |
| 74 | + && api != Opcodes.ASM4 |
| 75 | + && api != Opcodes.ASM8_EXPERIMENTAL) { |
| 76 | + throw new IllegalArgumentException("Unsupported api " + api); |
| 77 | + } |
| 78 | + if (api == Opcodes.ASM8_EXPERIMENTAL) { |
| 79 | + Constants.checkAsm8Experimental(this); |
| 80 | + } |
| 81 | + this.api = api; |
| 82 | + this.av = annotationVisitor; |
| 83 | + } |
| 84 | + |
| 85 | + /** |
| 86 | + * Visits a primitive value of the annotation. |
| 87 | + * |
| 88 | + * @param name the value name. |
| 89 | + * @param value the actual value, whose type must be {@link Byte}, {@link Boolean}, {@link |
| 90 | + * Character}, {@link Short}, {@link Integer} , {@link Long}, {@link Float}, {@link Double}, |
| 91 | + * {@link String} or {@link Type} of {@link Type#OBJECT} or {@link Type#ARRAY} sort. This |
| 92 | + * value can also be an array of byte, boolean, short, char, int, long, float or double values |
| 93 | + * (this is equivalent to using {@link #visitArray} and visiting each array element in turn, |
| 94 | + * but is more convenient). |
| 95 | + */ |
| 96 | + public void visit(final String name, final Object value) { |
| 97 | + if (av != null) { |
| 98 | + av.visit(name, value); |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Visits an enumeration value of the annotation. |
| 104 | + * |
| 105 | + * @param name the value name. |
| 106 | + * @param descriptor the class descriptor of the enumeration class. |
| 107 | + * @param value the actual enumeration value. |
| 108 | + */ |
| 109 | + public void visitEnum(final String name, final String descriptor, final String value) { |
| 110 | + if (av != null) { |
| 111 | + av.visitEnum(name, descriptor, value); |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + /** |
| 116 | + * Visits a nested annotation value of the annotation. |
| 117 | + * |
| 118 | + * @param name the value name. |
| 119 | + * @param descriptor the class descriptor of the nested annotation class. |
| 120 | + * @return a visitor to visit the actual nested annotation value, or {@literal null} if this |
| 121 | + * visitor is not interested in visiting this nested annotation. <i>The nested annotation |
| 122 | + * value must be fully visited before calling other methods on this annotation visitor</i>. |
| 123 | + */ |
| 124 | + public AnnotationVisitor visitAnnotation(final String name, final String descriptor) { |
| 125 | + if (av != null) { |
| 126 | + return av.visitAnnotation(name, descriptor); |
| 127 | + } |
| 128 | + return null; |
| 129 | + } |
| 130 | + |
| 131 | + /** |
| 132 | + * Visits an array value of the annotation. Note that arrays of primitive types (such as byte, |
| 133 | + * boolean, short, char, int, long, float or double) can be passed as value to {@link #visit |
| 134 | + * visit}. This is what {@link ClassReader} does. |
| 135 | + * |
| 136 | + * @param name the value name. |
| 137 | + * @return a visitor to visit the actual array value elements, or {@literal null} if this visitor |
| 138 | + * is not interested in visiting these values. The 'name' parameters passed to the methods of |
| 139 | + * this visitor are ignored. <i>All the array values must be visited before calling other |
| 140 | + * methods on this annotation visitor</i>. |
| 141 | + */ |
| 142 | + public AnnotationVisitor visitArray(final String name) { |
| 143 | + if (av != null) { |
| 144 | + return av.visitArray(name); |
| 145 | + } |
| 146 | + return null; |
| 147 | + } |
| 148 | + |
| 149 | + /** Visits the end of the annotation. */ |
| 150 | + public void visitEnd() { |
| 151 | + if (av != null) { |
| 152 | + av.visitEnd(); |
| 153 | + } |
| 154 | + } |
| 155 | +} |
0 commit comments