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 public class CheckFieldAdapter extends FieldVisitor {
72
73 private boolean end;
74
75 /**
76 * Constructs a new {@link CheckFieldAdapter}. <i>Subclasses must not use
77 * this constructor</i>. Instead, they must use the
78 * {@link #CheckFieldAdapter(int, FieldVisitor)} version.
79 *
80 * @param fv
81 * the field visitor to which this adapter must delegate calls.
82 * @throws IllegalStateException
83 * If a subclass calls this constructor.
84 */
85 public CheckFieldAdapter(final FieldVisitor fv) {
86 this(Opcodes.ASM6, fv);
87 if (getClass() != CheckFieldAdapter.class) {
88 throw new IllegalStateException();
89 }
90 }
91
92 /**
93 * Constructs a new {@link CheckFieldAdapter}.
94 *
95 * @param api
96 * the ASM API version implemented by this visitor. Must be one
97 * of {@link Opcodes#ASM4}, {@link Opcodes#ASM5} or {@link Opcodes#ASM6}.
98 * @param fv
99 * the field visitor to which this adapter must delegate calls.
100 */
101 protected CheckFieldAdapter(final int api, final FieldVisitor fv) {
102 super(api, fv);
103 }
104
105 @Override
106 public AnnotationVisitor visitAnnotation(final String desc,
107 final boolean visible) {
108 checkEnd();
109 CheckMethodAdapter.checkDesc(desc, false);
110 return new CheckAnnotationAdapter(super.visitAnnotation(desc, visible));
111 }
112
113 @Override
114 public AnnotationVisitor visitTypeAnnotation(final int typeRef,
115 final TypePath typePath, final String desc, final boolean visible) {
116 checkEnd();
117 int sort = typeRef >>> 24;
118 if (sort != TypeReference.FIELD) {
119 throw new IllegalArgumentException("Invalid type reference sort 0x"
120 + Integer.toHexString(sort));
121 }
122 CheckClassAdapter.checkTypeRefAndPath(typeRef, typePath);
123 CheckMethodAdapter.checkDesc(desc, false);
124 return new CheckAnnotationAdapter(super.visitTypeAnnotation(typeRef,
125 typePath, desc, visible));
126 }
127
128 @Override
129 public void visitAttribute(final Attribute attr) {
130 checkEnd();
131 if (attr == null) {
132 throw new IllegalArgumentException(
133 "Invalid attribute (must not be null)");
134 }
135 super.visitAttribute(attr);
136 }
137
138 @Override
139 public void visitEnd() {
140 checkEnd();
141 end = true;
142 super.visitEnd();
143 }
144
145 private void checkEnd() {
146 if (end) {
147 throw new IllegalStateException(
148 "Cannot call a visit method after visitEnd has been called");
149 }
150 }
151 }