mirror of
https://github.com/openjdk/jdk.git
synced 2026-01-29 12:38:24 +00:00
109 lines
4.1 KiB
Java
109 lines
4.1 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.ClassFile;
|
|
import java.lang.classfile.MethodElement;
|
|
import java.lang.classfile.constantpool.ClassEntry;
|
|
import java.lang.constant.ClassDesc;
|
|
import java.lang.reflect.Executable;
|
|
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#exceptions() Exceptions} attribute (JVMS {@jvms
|
|
* 4.7.5}), which records the exceptions declared to be thrown by this
|
|
* method.
|
|
* <p>
|
|
* This attribute only appears on methods, and does not permit {@linkplain
|
|
* AttributeMapper#allowMultiple multiple instances} in a method. It has a
|
|
* data dependency on the {@linkplain AttributeStability#CP_REFS constant pool}.
|
|
* <p>
|
|
* The attribute was introduced in the Java Platform version 1.0.2, major
|
|
* version {@value ClassFile#JAVA_1_VERSION}.
|
|
*
|
|
* @apiNote
|
|
* Generic exceptions types thrown by a method and potentially annotated use of
|
|
* those types are defined by {@link SignatureAttribute} and {@link
|
|
* RuntimeVisibleTypeAnnotationsAttribute} respectively, which requires this
|
|
* attribute to be present.
|
|
*
|
|
* @see Attributes#exceptions()
|
|
* @jvms 4.7.5 The {@code Exceptions} Attribute
|
|
* @since 24
|
|
*/
|
|
public sealed interface ExceptionsAttribute
|
|
extends Attribute<ExceptionsAttribute>, MethodElement
|
|
permits BoundAttribute.BoundExceptionsAttribute,
|
|
UnboundAttribute.UnboundExceptionsAttribute {
|
|
|
|
/**
|
|
* {@return the exceptions declared to be thrown by this method}
|
|
*
|
|
* @see Executable#getExceptionTypes()
|
|
*/
|
|
List<ClassEntry> exceptions();
|
|
|
|
/**
|
|
* {@return an {@code Exceptions} attribute}
|
|
* @param exceptions the exceptions that may be thrown from this method
|
|
*/
|
|
static ExceptionsAttribute of(List<ClassEntry> exceptions) {
|
|
return new UnboundAttribute.UnboundExceptionsAttribute(exceptions);
|
|
}
|
|
|
|
/**
|
|
* {@return an {@code Exceptions} attribute}
|
|
* @param exceptions the exceptions that may be thrown from this method
|
|
*/
|
|
static ExceptionsAttribute of(ClassEntry... exceptions) {
|
|
return of(List.of(exceptions));
|
|
}
|
|
|
|
/**
|
|
* {@return an {@code Exceptions} attribute}
|
|
* @param exceptions the exceptions that may be thrown from this method
|
|
*/
|
|
static ExceptionsAttribute ofSymbols(List<ClassDesc> exceptions) {
|
|
return of(Util.entryList(exceptions));
|
|
}
|
|
|
|
/**
|
|
* {@return an {@code Exceptions} attribute}
|
|
* @param exceptions the exceptions that may be thrown from this method
|
|
*/
|
|
static ExceptionsAttribute ofSymbols(ClassDesc... exceptions) {
|
|
return ofSymbols(Arrays.asList(exceptions));
|
|
}
|
|
}
|