1 /*
2 * Copyright (c) 2022, 2024, Oracle and/or its affiliates. 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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package java.lang.classfile;
26
27 import java.lang.classfile.attribute.AnnotationDefaultAttribute;
28 import java.lang.classfile.attribute.BootstrapMethodsAttribute;
29 import java.lang.classfile.attribute.CharacterRangeTableAttribute;
30 import java.lang.classfile.attribute.CodeAttribute;
31 import java.lang.classfile.attribute.CompilationIDAttribute;
32 import java.lang.classfile.attribute.ConstantValueAttribute;
33 import java.lang.classfile.attribute.DeprecatedAttribute;
34 import java.lang.classfile.attribute.EnclosingMethodAttribute;
35 import java.lang.classfile.attribute.ExceptionsAttribute;
36 import java.lang.classfile.attribute.InnerClassesAttribute;
37 import java.lang.classfile.attribute.LineNumberTableAttribute;
38 import java.lang.classfile.attribute.LocalVariableTableAttribute;
39 import java.lang.classfile.attribute.LocalVariableTypeTableAttribute;
40 import java.lang.classfile.attribute.MethodParametersAttribute;
41 import java.lang.classfile.attribute.ModuleAttribute;
42 import java.lang.classfile.attribute.ModuleHashesAttribute;
43 import java.lang.classfile.attribute.ModuleMainClassAttribute;
44 import java.lang.classfile.attribute.ModulePackagesAttribute;
45 import java.lang.classfile.attribute.ModuleResolutionAttribute;
46 import java.lang.classfile.attribute.ModuleTargetAttribute;
47 import java.lang.classfile.attribute.NestHostAttribute;
48 import java.lang.classfile.attribute.NestMembersAttribute;
49 import java.lang.classfile.attribute.PermittedSubclassesAttribute;
50 import java.lang.classfile.attribute.RecordAttribute;
51 import java.lang.classfile.attribute.RuntimeInvisibleAnnotationsAttribute;
52 import java.lang.classfile.attribute.RuntimeInvisibleParameterAnnotationsAttribute;
53 import java.lang.classfile.attribute.RuntimeInvisibleTypeAnnotationsAttribute;
54 import java.lang.classfile.attribute.RuntimeVisibleAnnotationsAttribute;
55 import java.lang.classfile.attribute.RuntimeVisibleParameterAnnotationsAttribute;
56 import java.lang.classfile.attribute.RuntimeVisibleTypeAnnotationsAttribute;
57 import java.lang.classfile.attribute.SignatureAttribute;
58 import java.lang.classfile.attribute.SourceDebugExtensionAttribute;
59 import java.lang.classfile.attribute.SourceFileAttribute;
60 import java.lang.classfile.attribute.SourceIDAttribute;
61 import java.lang.classfile.attribute.StackMapTableAttribute;
62 import java.lang.classfile.attribute.SyntheticAttribute;
63 import java.lang.classfile.attribute.UnknownAttribute;
64 import jdk.internal.classfile.impl.BoundAttribute;
65 import jdk.internal.classfile.impl.UnboundAttribute;
66 import jdk.internal.javac.PreviewFeature;
67
68 /**
69 * Models a classfile attribute (JVMS {@jvms 4.7}). Many, though not all, subtypes of
70 * {@linkplain Attribute} will implement {@link ClassElement}, {@link
71 * MethodElement}, {@link FieldElement}, or {@link CodeElement}; attributes that
72 * are also elements will be delivered when traversing the elements of the
73 * corresponding model type. Additionally, all attributes are accessible
74 * directly from the corresponding model type through {@link
75 * AttributedElement#findAttribute(AttributeMapper)}.
76 * @param <A> the attribute type
77 *
78 * @sealedGraph
79 * @since 22
80 */
81 @PreviewFeature(feature = PreviewFeature.Feature.CLASSFILE_API)
82 public sealed interface Attribute<A extends Attribute<A>>
83 extends ClassFileElement
84 permits AnnotationDefaultAttribute, BootstrapMethodsAttribute,
85 CharacterRangeTableAttribute, CodeAttribute, CompilationIDAttribute,
86 ConstantValueAttribute, DeprecatedAttribute, EnclosingMethodAttribute,
87 ExceptionsAttribute, InnerClassesAttribute, LineNumberTableAttribute,
88 LocalVariableTableAttribute, LocalVariableTypeTableAttribute,
89 MethodParametersAttribute, ModuleAttribute, ModuleHashesAttribute,
90 ModuleMainClassAttribute, ModulePackagesAttribute, ModuleResolutionAttribute,
91 ModuleTargetAttribute, NestHostAttribute, NestMembersAttribute,
92 PermittedSubclassesAttribute,
93 RecordAttribute, RuntimeInvisibleAnnotationsAttribute,
94 RuntimeInvisibleParameterAnnotationsAttribute, RuntimeInvisibleTypeAnnotationsAttribute,
95 RuntimeVisibleAnnotationsAttribute, RuntimeVisibleParameterAnnotationsAttribute,
96 RuntimeVisibleTypeAnnotationsAttribute, SignatureAttribute,
97 SourceDebugExtensionAttribute, SourceFileAttribute, SourceIDAttribute,
98 StackMapTableAttribute, SyntheticAttribute,
99 UnknownAttribute, BoundAttribute, UnboundAttribute, CustomAttribute {
100 /**
101 * {@return the name of the attribute}
102 */
103 String attributeName();
104
105 /**
106 * {@return the {@link AttributeMapper} associated with this attribute}
107 */
108 AttributeMapper<A> attributeMapper();
109 }