mirror of
https://github.com/openjdk/jdk.git
synced 2026-01-28 12:09:14 +00:00
118 lines
4.6 KiB
Java
118 lines
4.6 KiB
Java
/*
|
|
* Copyright (c) 2022, 2025, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
package java.lang.classfile.attribute;
|
|
|
|
import java.lang.classfile.Attribute;
|
|
import java.lang.classfile.AttributeMapper;
|
|
import java.lang.classfile.AttributeMapper.AttributeStability;
|
|
import java.lang.classfile.Attributes;
|
|
import java.lang.classfile.ClassElement;
|
|
import java.lang.classfile.ClassFile;
|
|
import java.lang.classfile.constantpool.ClassEntry;
|
|
import java.lang.constant.ClassDesc;
|
|
import java.util.Arrays;
|
|
import java.util.List;
|
|
|
|
import jdk.internal.classfile.impl.BoundAttribute;
|
|
import jdk.internal.classfile.impl.UnboundAttribute;
|
|
import jdk.internal.classfile.impl.Util;
|
|
|
|
/**
|
|
* Models the {@link Attributes#nestMembers() NestMembers} attribute (JVMS
|
|
* {@jvms 4.7.29}), which indicates that this class is the host of a nest
|
|
* and the other nest members.
|
|
* <p>
|
|
* This attribute only appears on classes, and does not permit {@linkplain
|
|
* AttributeMapper#allowMultiple multiple instances} in a class. It has a
|
|
* data dependency on the {@linkplain AttributeStability#CP_REFS constant pool}.
|
|
* <p>
|
|
* The attribute was introduced in the Java SE Platform version 11, major
|
|
* version {@value ClassFile#JAVA_11_VERSION}.
|
|
*
|
|
* @see Attributes#nestMembers()
|
|
* @see NestHostAttribute
|
|
* @see Class#getNestMembers()
|
|
* @see Class#isNestmateOf(Class)
|
|
* @jvms 4.7.29 The {@code NestMembers} Attribute
|
|
* @since 24
|
|
*/
|
|
public sealed interface NestMembersAttribute extends Attribute<NestMembersAttribute>, ClassElement
|
|
permits BoundAttribute.BoundNestMembersAttribute, UnboundAttribute.UnboundNestMembersAttribute {
|
|
|
|
/**
|
|
* {@return the classes belonging to the nest hosted by this class}
|
|
*
|
|
* @see Class#getNestMembers()
|
|
*/
|
|
List<ClassEntry> nestMembers();
|
|
|
|
/**
|
|
* {@return a {@code NestMembers} attribute}
|
|
*
|
|
* @param nestMembers the member classes of the nest
|
|
* @throws IllegalArgumentException if the number of member classes exceeds
|
|
* the limit of {@link java.lang.classfile##u2 u2}
|
|
*/
|
|
static NestMembersAttribute of(List<ClassEntry> nestMembers) {
|
|
return new UnboundAttribute.UnboundNestMembersAttribute(nestMembers);
|
|
}
|
|
|
|
/**
|
|
* {@return a {@code NestMembers} attribute}
|
|
*
|
|
* @param nestMembers the member classes of the nest
|
|
* @throws IllegalArgumentException if the number of member classes exceeds
|
|
* the limit of {@link java.lang.classfile##u2 u2}
|
|
*/
|
|
static NestMembersAttribute of(ClassEntry... nestMembers) {
|
|
return of(List.of(nestMembers));
|
|
}
|
|
|
|
/**
|
|
* {@return a {@code NestMembers} attribute}
|
|
*
|
|
* @param nestMembers the member classes of the nest
|
|
* @throws IllegalArgumentException if any of {@code nestMembers} is primitive,
|
|
* or if the number of member classes exceeds the limit of {@link
|
|
* java.lang.classfile##u2 u2}
|
|
*/
|
|
static NestMembersAttribute ofSymbols(List<ClassDesc> nestMembers) {
|
|
return of(Util.entryList(nestMembers));
|
|
}
|
|
|
|
/**
|
|
* {@return a {@code NestMembers} attribute}
|
|
*
|
|
* @param nestMembers the member classes of the nest
|
|
* @throws IllegalArgumentException if any of {@code nestMembers} is primitive,
|
|
* or if the number of member classes exceeds the limit of {@link
|
|
* java.lang.classfile##u2 u2}
|
|
*/
|
|
static NestMembersAttribute ofSymbols(ClassDesc... nestMembers) {
|
|
// List version does defensive copy
|
|
return ofSymbols(Arrays.asList(nestMembers));
|
|
}
|
|
}
|