Fri, 26 Jun 2009 18:51:39 -0700
6843077: JSR 308: Annotations on types
Reviewed-by: jjg, mcimadamore, darcy
Contributed-by: mernst@cs.washington.edu, mali@csail.mit.edu, mpapi@csail.mit.edu
1 /*
2 * Copyright 2007-2008 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
26 package com.sun.tools.classfile;
28 import java.io.IOException;
29 import java.lang.reflect.Constructor;
30 import java.util.HashMap;
31 import java.util.Map;
33 /**
34 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
35 * you write code that depends on this, you do so at your own risk.
36 * This code and its internal interfaces are subject to change or
37 * deletion without notice.</b>
38 */
40 public abstract class Attribute {
41 public static final String AnnotationDefault = "AnnotationDefault";
42 public static final String CharacterRangeTable = "CharacterRangeTable";
43 public static final String Code = "Code";
44 public static final String ConstantValue = "ConstantValue";
45 public static final String CompilationID = "CompilationID";
46 public static final String Deprecated = "Deprecated";
47 public static final String EnclosingMethod = "EnclosingMethod";
48 public static final String Exceptions = "Exceptions";
49 public static final String InnerClasses = "InnerClasses";
50 public static final String LineNumberTable = "LineNumberTable";
51 public static final String LocalVariableTable = "LocalVariableTable";
52 public static final String LocalVariableTypeTable = "LocalVariableTypeTable";
53 public static final String RuntimeVisibleAnnotations = "RuntimeVisibleAnnotations";
54 public static final String RuntimeInvisibleAnnotations = "RuntimeInvisibleAnnotations";
55 public static final String RuntimeVisibleParameterAnnotations = "RuntimeVisibleParameterAnnotations";
56 public static final String RuntimeInvisibleParameterAnnotations = "RuntimeInvisibleParameterAnnotations";
57 public static final String RuntimeVisibleTypeAnnotations = "RuntimeVisibleTypeAnnotations";
58 public static final String RuntimeInvisibleTypeAnnotations = "RuntimeInvisibleTypeAnnotations";
59 public static final String Signature = "Signature";
60 public static final String SourceDebugExtension = "SourceDebugExtension";
61 public static final String SourceFile = "SourceFile";
62 public static final String SourceID = "SourceID";
63 public static final String StackMap = "StackMap";
64 public static final String StackMapTable = "StackMapTable";
65 public static final String Synthetic = "Synthetic";
67 // JSR 277/294
68 public static final String Module = "Module";
69 public static final String ModuleExportTable = "ModuleExportTable";
70 public static final String ModuleMemberTable = "ModuleMemberTable";
72 public static class Factory {
73 public Factory() {
74 // defer init of standardAttributeClasses until after options set up
75 }
77 public void setCompat(boolean compat) {
78 this.compat = compat;
79 }
81 public void setJSR277(boolean jsr277) {
82 this.jsr277 = jsr277;
83 }
85 public Attribute createAttribute(ClassReader cr, int name_index, byte[] data)
86 throws IOException {
87 if (standardAttributes == null)
88 init();
90 ConstantPool cp = cr.getConstantPool();
91 try {
92 String name = cp.getUTF8Value(name_index);
93 Class<? extends Attribute> attrClass = standardAttributes.get(name);
94 if (attrClass != null) {
95 try {
96 Class<?>[] constrArgTypes = {ClassReader.class, int.class, int.class};
97 Constructor<? extends Attribute> constr = attrClass.getDeclaredConstructor(constrArgTypes);
98 return constr.newInstance(new Object[] { cr, name_index, data.length });
99 } catch (Throwable t) {
100 // fall through and use DefaultAttribute
101 // t.printStackTrace();
102 }
103 }
104 } catch (ConstantPoolException e) {
105 // fall through and use DefaultAttribute
106 }
107 return new DefaultAttribute(cr, name_index, data);
108 }
110 protected void init() {
111 standardAttributes = new HashMap<String,Class<? extends Attribute>>();
112 standardAttributes.put(AnnotationDefault, AnnotationDefault_attribute.class);
113 standardAttributes.put(CharacterRangeTable, CharacterRangeTable_attribute.class);
114 standardAttributes.put(Code, Code_attribute.class);
115 standardAttributes.put(ConstantValue, ConstantValue_attribute.class);
116 standardAttributes.put(Deprecated, Deprecated_attribute.class);
117 standardAttributes.put(EnclosingMethod, EnclosingMethod_attribute.class);
118 standardAttributes.put(Exceptions, Exceptions_attribute.class);
119 standardAttributes.put(InnerClasses, InnerClasses_attribute.class);
120 standardAttributes.put(LineNumberTable, LineNumberTable_attribute.class);
121 standardAttributes.put(LocalVariableTable, LocalVariableTable_attribute.class);
122 standardAttributes.put(LocalVariableTypeTable, LocalVariableTypeTable_attribute.class);
124 if (jsr277) {
125 standardAttributes.put(Module, Module_attribute.class);
126 standardAttributes.put(ModuleExportTable, ModuleExportTable_attribute.class);
127 standardAttributes.put(ModuleMemberTable, ModuleMemberTable_attribute.class);
128 }
130 if (!compat) { // old javap does not recognize recent attributes
131 standardAttributes.put(CompilationID, CompilationID_attribute.class);
132 standardAttributes.put(RuntimeInvisibleAnnotations, RuntimeInvisibleAnnotations_attribute.class);
133 standardAttributes.put(RuntimeInvisibleParameterAnnotations, RuntimeInvisibleParameterAnnotations_attribute.class);
134 standardAttributes.put(RuntimeVisibleAnnotations, RuntimeVisibleAnnotations_attribute.class);
135 standardAttributes.put(RuntimeVisibleParameterAnnotations, RuntimeVisibleParameterAnnotations_attribute.class);
136 standardAttributes.put(RuntimeVisibleTypeAnnotations, RuntimeVisibleTypeAnnotations_attribute.class);
137 standardAttributes.put(RuntimeInvisibleTypeAnnotations, RuntimeInvisibleTypeAnnotations_attribute.class);
138 standardAttributes.put(Signature, Signature_attribute.class);
139 standardAttributes.put(SourceID, SourceID_attribute.class);
140 }
142 standardAttributes.put(SourceDebugExtension, SourceDebugExtension_attribute.class);
143 standardAttributes.put(SourceFile, SourceFile_attribute.class);
144 standardAttributes.put(StackMap, StackMap_attribute.class);
145 standardAttributes.put(StackMapTable, StackMapTable_attribute.class);
146 standardAttributes.put(Synthetic, Synthetic_attribute.class);
147 }
149 private Map<String,Class<? extends Attribute>> standardAttributes;
150 private boolean compat; // don't support recent attrs in compatibility mode
151 private boolean jsr277; // support new jsr277 attrs
152 }
154 public static Attribute read(ClassReader cr) throws IOException {
155 return cr.readAttribute();
156 }
158 protected Attribute(int name_index, int length) {
159 attribute_name_index = name_index;
160 attribute_length = length;
161 }
163 public String getName(ConstantPool constant_pool) throws ConstantPoolException {
164 return constant_pool.getUTF8Value(attribute_name_index);
165 }
167 public abstract <R,D> R accept(Attribute.Visitor<R,D> visitor, D data);
169 public final int attribute_name_index;
170 public final int attribute_length;
173 public interface Visitor<R,P> {
174 R visitDefault(DefaultAttribute attr, P p);
175 R visitAnnotationDefault(AnnotationDefault_attribute attr, P p);
176 R visitCharacterRangeTable(CharacterRangeTable_attribute attr, P p);
177 R visitCode(Code_attribute attr, P p);
178 R visitCompilationID(CompilationID_attribute attr, P p);
179 R visitConstantValue(ConstantValue_attribute attr, P p);
180 R visitDeprecated(Deprecated_attribute attr, P p);
181 R visitEnclosingMethod(EnclosingMethod_attribute attr, P p);
182 R visitExceptions(Exceptions_attribute attr, P p);
183 R visitInnerClasses(InnerClasses_attribute attr, P p);
184 R visitLineNumberTable(LineNumberTable_attribute attr, P p);
185 R visitLocalVariableTable(LocalVariableTable_attribute attr, P p);
186 R visitLocalVariableTypeTable(LocalVariableTypeTable_attribute attr, P p);
187 R visitRuntimeVisibleAnnotations(RuntimeVisibleAnnotations_attribute attr, P p);
188 R visitRuntimeInvisibleAnnotations(RuntimeInvisibleAnnotations_attribute attr, P p);
189 R visitRuntimeVisibleParameterAnnotations(RuntimeVisibleParameterAnnotations_attribute attr, P p);
190 R visitRuntimeInvisibleParameterAnnotations(RuntimeInvisibleParameterAnnotations_attribute attr, P p);
191 R visitRuntimeVisibleTypeAnnotations(RuntimeVisibleTypeAnnotations_attribute attr, P p);
192 R visitRuntimeInvisibleTypeAnnotations(RuntimeInvisibleTypeAnnotations_attribute attr, P p);
193 R visitSignature(Signature_attribute attr, P p);
194 R visitSourceDebugExtension(SourceDebugExtension_attribute attr, P p);
195 R visitSourceFile(SourceFile_attribute attr, P p);
196 R visitSourceID(SourceID_attribute attr, P p);
197 R visitStackMap(StackMap_attribute attr, P p);
198 R visitStackMapTable(StackMapTable_attribute attr, P p);
199 R visitSynthetic(Synthetic_attribute attr, P p);
201 R visitModule(Module_attribute attr, P p);
202 R visitModuleExportTable(ModuleExportTable_attribute attr, P p);
203 R visitModuleMemberTable(ModuleMemberTable_attribute attr, P p);
204 }
205 }