1 /* 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 * 4 * This code is free software; you can redistribute it and/or modify it 5 * under the terms of the GNU General Public License version 2 only, as 6 * published by the Free Software Foundation. Oracle designates this 7 * particular file as subject to the "Classpath" exception as provided 8 * by Oracle in the LICENSE file that accompanied this code. 9 * 10 * This code is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * version 2 for more details (a copy is included in the LICENSE file that 14 * accompanied this code). 15 * 16 * You should have received a copy of the GNU General Public License version 17 * 2 along with this work; if not, write to the Free Software Foundation, 18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 * 20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 * or visit www.oracle.com if you need additional information or have any 22 * questions. 23 */ 24 25 /* 26 * This file is available under and governed by the GNU General Public 27 * License version 2 only, as published by the Free Software Foundation. 28 * However, the following notice accompanied the original version of this 29 * file: 30 * 31 * ASM: a very small and fast Java bytecode manipulation framework 32 * Copyright (c) 2000-2011 INRIA, France Telecom 33 * All rights reserved. 34 * 35 * Redistribution and use in source and binary forms, with or without 36 * modification, are permitted provided that the following conditions 37 * are met: 38 * 1. Redistributions of source code must retain the above copyright 39 * notice, this list of conditions and the following disclaimer. 40 * 2. Redistributions in binary form must reproduce the above copyright 41 * notice, this list of conditions and the following disclaimer in the 42 * documentation and/or other materials provided with the distribution. 43 * 3. Neither the name of the copyright holders nor the names of its 44 * contributors may be used to endorse or promote products derived from 45 * this software without specific prior written permission. 46 * 47 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 48 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 50 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 51 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 52 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 53 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 54 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 55 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 56 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 57 * THE POSSIBILITY OF SUCH DAMAGE. 58 */ 59 package jdk.internal.org.objectweb.asm.util; 60 61 import jdk.internal.org.objectweb.asm.AnnotationVisitor; 62 import jdk.internal.org.objectweb.asm.Attribute; 63 import jdk.internal.org.objectweb.asm.FieldVisitor; 64 import jdk.internal.org.objectweb.asm.Opcodes; 65 import jdk.internal.org.objectweb.asm.TypePath; 66 import jdk.internal.org.objectweb.asm.TypeReference; 67 68 /** 69 * A {@link FieldVisitor} that checks that its methods are properly used. 70 * 71 * @author Eric Bruneton 72 */ 73 public class CheckFieldAdapter extends FieldVisitor { 74 75 /** Whether the {@link #visitEnd} method has been called. */ 76 private boolean visitEndCalled; 77 78 /** 79 * Constructs a new {@link CheckFieldAdapter}. <i>Subclasses must not use this constructor</i>. 80 * Instead, they must use the {@link #CheckFieldAdapter(int, FieldVisitor)} version. 81 * 82 * @param fieldVisitor the field visitor to which this adapter must delegate calls. 83 * @throws IllegalStateException If a subclass calls this constructor. 84 */ CheckFieldAdapter(final FieldVisitor fieldVisitor)85 public CheckFieldAdapter(final FieldVisitor fieldVisitor) { 86 this(/* latest api = */ Opcodes.ASM8, fieldVisitor); 87 if (getClass() != CheckFieldAdapter.class) { 88 throw new IllegalStateException(); 89 } 90 } 91 92 /** 93 * Constructs a new {@link CheckFieldAdapter}. 94 * 95 * @param api the ASM API version implemented by this visitor. Must be one of {@link 96 * Opcodes#ASM4}, {@link Opcodes#ASM5}, {@link Opcodes#ASM6}, {@link Opcodes#ASM7} or {@link 97 * Opcodes#ASM8}. 98 * @param fieldVisitor the field visitor to which this adapter must delegate calls. 99 */ CheckFieldAdapter(final int api, final FieldVisitor fieldVisitor)100 protected CheckFieldAdapter(final int api, final FieldVisitor fieldVisitor) { 101 super(api, fieldVisitor); 102 } 103 104 @Override visitAnnotation(final String descriptor, final boolean visible)105 public AnnotationVisitor visitAnnotation(final String descriptor, final boolean visible) { 106 checkVisitEndNotCalled(); 107 // Annotations can only appear in V1_5 or more classes. 108 CheckMethodAdapter.checkDescriptor(Opcodes.V1_5, descriptor, false); 109 return new CheckAnnotationAdapter(super.visitAnnotation(descriptor, visible)); 110 } 111 112 @Override visitTypeAnnotation( final int typeRef, final TypePath typePath, final String descriptor, final boolean visible)113 public AnnotationVisitor visitTypeAnnotation( 114 final int typeRef, final TypePath typePath, final String descriptor, final boolean visible) { 115 checkVisitEndNotCalled(); 116 int sort = new TypeReference(typeRef).getSort(); 117 if (sort != TypeReference.FIELD) { 118 throw new IllegalArgumentException( 119 "Invalid type reference sort 0x" + Integer.toHexString(sort)); 120 } 121 CheckClassAdapter.checkTypeRef(typeRef); 122 CheckMethodAdapter.checkDescriptor(Opcodes.V1_5, descriptor, false); 123 return new CheckAnnotationAdapter( 124 super.visitTypeAnnotation(typeRef, typePath, descriptor, visible)); 125 } 126 127 @Override visitAttribute(final Attribute attribute)128 public void visitAttribute(final Attribute attribute) { 129 checkVisitEndNotCalled(); 130 if (attribute == null) { 131 throw new IllegalArgumentException("Invalid attribute (must not be null)"); 132 } 133 super.visitAttribute(attribute); 134 } 135 136 @Override visitEnd()137 public void visitEnd() { 138 checkVisitEndNotCalled(); 139 visitEndCalled = true; 140 super.visitEnd(); 141 } 142 checkVisitEndNotCalled()143 private void checkVisitEndNotCalled() { 144 if (visitEndCalled) { 145 throw new IllegalStateException("Cannot call a visit method after visitEnd has been called"); 146 } 147 } 148 } 149