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.*;
28 
29 import jdk.internal.classfile.impl.BoundAttribute;
30 import jdk.internal.classfile.impl.UnboundAttribute;
31 import jdk.internal.javac.PreviewFeature;
32 
33 /**
34  * Models a classfile attribute (JVMS {@jvms 4.7}).  Many, though not all, subtypes of
35  * {@linkplain Attribute} will implement {@link ClassElement}, {@link
36  * MethodElement}, {@link FieldElement}, or {@link CodeElement}; attributes that
37  * are also elements will be delivered when traversing the elements of the
38  * corresponding model type. Additionally, all attributes are accessible
39  * directly from the corresponding model type through {@link
40  * AttributedElement#findAttribute(AttributeMapper)}.
41  * @param <A> the attribute type
42  *
43  * @sealedGraph
44  * @since 22
45  */
46 @PreviewFeature(feature = PreviewFeature.Feature.CLASSFILE_API)
47 public sealed interface Attribute<A extends Attribute<A>>
48         extends ClassFileElement
49         permits AnnotationDefaultAttribute, BootstrapMethodsAttribute,
50                 CharacterRangeTableAttribute, CodeAttribute, CompilationIDAttribute,
51                 ConstantValueAttribute, DeprecatedAttribute, EnclosingMethodAttribute,
52                 ExceptionsAttribute, InnerClassesAttribute, LineNumberTableAttribute,
53                 LoadableDescriptorsAttribute, LocalVariableTableAttribute, LocalVariableTypeTableAttribute,
54                 MethodParametersAttribute, ModuleAttribute, ModuleHashesAttribute,
55                 ModuleMainClassAttribute, ModulePackagesAttribute, ModuleResolutionAttribute,
56                 ModuleTargetAttribute, NestHostAttribute, NestMembersAttribute,
57                 PermittedSubclassesAttribute,
58                 RecordAttribute, RuntimeInvisibleAnnotationsAttribute,
59                 RuntimeInvisibleParameterAnnotationsAttribute, RuntimeInvisibleTypeAnnotationsAttribute,
60                 RuntimeVisibleAnnotationsAttribute, RuntimeVisibleParameterAnnotationsAttribute,
61                 RuntimeVisibleTypeAnnotationsAttribute, SignatureAttribute,
62                 SourceDebugExtensionAttribute, SourceFileAttribute, SourceIDAttribute,
63                 StackMapTableAttribute, SyntheticAttribute,
64                 UnknownAttribute, BoundAttribute, UnboundAttribute, CustomAttribute {
65     /**
66      * {@return the name of the attribute}
67      */
68     String attributeName();
69 
70     /**
71      * {@return the {@link AttributeMapper} associated with this attribute}
72      */
73     AttributeMapper<A> attributeMapper();
74 }