mirror of
https://github.com/openjdk/jdk.git
synced 2026-01-29 12:38:24 +00:00
98 lines
3.7 KiB
Java
98 lines
3.7 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.ClassModel;
|
|
import java.lang.classfile.constantpool.Utf8Entry;
|
|
|
|
import jdk.internal.classfile.impl.BoundAttribute;
|
|
import jdk.internal.classfile.impl.TemporaryConstantPool;
|
|
import jdk.internal.classfile.impl.UnboundAttribute;
|
|
|
|
/**
|
|
* Models the {@link Attributes#moduleTarget() ModuleTarget} attribute, which
|
|
* can appear on classes that {@linkplain ClassModel#isModuleInfo() represent}
|
|
* module descriptors, to represent constraints on the target platform.
|
|
* <p>
|
|
* The specification of the {@code ModuleTarget} attribute is:
|
|
* <pre> {@code
|
|
* TargetPlatform_attribute {
|
|
* // index to CONSTANT_utf8_info structure in constant pool representing
|
|
* // the string "ModuleTarget"
|
|
* u2 attribute_name_index;
|
|
* u4 attribute_length;
|
|
*
|
|
* // index to CONSTANT_utf8_info structure with the target platform
|
|
* u2 target_platform_index;
|
|
* }
|
|
* } </pre>
|
|
* <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>
|
|
* This attribute is not predefined in the Java SE Platform. This is a
|
|
* JDK-specific nonstandard attribute produced by the {@code jdk.jlink} module,
|
|
* which defines the {@code jlink} and {@code jmod} tools.
|
|
*
|
|
* @see Attributes#moduleTarget()
|
|
* @see ModuleHashesAttribute
|
|
* @see ModuleResolutionAttribute
|
|
* @since 24
|
|
*/
|
|
public sealed interface ModuleTargetAttribute
|
|
extends Attribute<ModuleTargetAttribute>, ClassElement
|
|
permits BoundAttribute.BoundModuleTargetAttribute, UnboundAttribute.UnboundModuleTargetAttribute {
|
|
|
|
/**
|
|
* {@return the target platform}
|
|
*/
|
|
Utf8Entry targetPlatform();
|
|
|
|
/**
|
|
* {@return a {@code ModuleTarget} attribute}
|
|
*
|
|
* @param targetPlatform the target platform
|
|
*/
|
|
static ModuleTargetAttribute of(String targetPlatform) {
|
|
return of(TemporaryConstantPool.INSTANCE.utf8Entry(targetPlatform));
|
|
}
|
|
|
|
/**
|
|
* {@return a {@code ModuleTarget} attribute}
|
|
*
|
|
* @param targetPlatform the target platform
|
|
*/
|
|
static ModuleTargetAttribute of(Utf8Entry targetPlatform) {
|
|
return new UnboundAttribute.UnboundModuleTargetAttribute(targetPlatform);
|
|
}
|
|
}
|