mirror of
https://github.com/openjdk/jdk.git
synced 2026-01-28 20:18:48 +00:00
73 lines
3.0 KiB
Java
73 lines
3.0 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.io.DataInput;
|
|
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 jdk.internal.classfile.impl.BoundAttribute;
|
|
import jdk.internal.classfile.impl.UnboundAttribute;
|
|
|
|
/**
|
|
* Models the {@link Attributes#sourceDebugExtension() SourceDebugExtension}
|
|
* attribute (JVMS {@jvms 4.7.11}), which stores arbitrary {@linkplain
|
|
* DataInput##modified-utf-8 modified UTF-8} data.
|
|
* <p>
|
|
* This attribute only appears on classes, and does not permit {@linkplain
|
|
* AttributeMapper#allowMultiple multiple instances} in a class. It has
|
|
* {@linkplain AttributeStability#STATELESS no data dependency}.
|
|
* <p>
|
|
* The attribute was introduced in the Java SE Platform version 5.0, major
|
|
* version {@value ClassFile#JAVA_5_VERSION}.
|
|
*
|
|
* @see Attributes#sourceDebugExtension()
|
|
* @jvms 4.7.11 The {@code SourceDebugExtension} Attribute
|
|
* @since 24
|
|
*/
|
|
public sealed interface SourceDebugExtensionAttribute
|
|
extends Attribute<SourceDebugExtensionAttribute>, ClassElement
|
|
permits BoundAttribute.BoundSourceDebugExtensionAttribute, UnboundAttribute.UnboundSourceDebugExtensionAttribute {
|
|
|
|
/**
|
|
* {@return the debug extension payload} The payload may denote a string
|
|
* longer than that which can be represented with a {@link String}.
|
|
*/
|
|
byte[] contents();
|
|
|
|
/**
|
|
* {@return a {@code SourceDebugExtension} attribute}
|
|
* @param contents the extension contents
|
|
*/
|
|
static SourceDebugExtensionAttribute of(byte[] contents) {
|
|
return new UnboundAttribute.UnboundSourceDebugExtensionAttribute(contents);
|
|
}
|
|
}
|