src/java.base/share/classes/java/lang/classfile/CodeModel.java - master - wstartsev/jdk

src/java.base/share/classes/java/lang/classfile/CodeModel.java
82 строки3 KB
Chen Liang
8342465: Improve API documentation for java.lang.classfile
27 янв 2025, 17:03
27 янв 2025, 17:031d8ccb8
/*
 * 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;

import java.lang.classfile.ClassFile.DeadLabelsOption;
import java.lang.classfile.ClassFile.DebugElementsOption;
import java.lang.classfile.ClassFile.LineNumbersOption;
import java.lang.classfile.attribute.BootstrapMethodsAttribute;
import java.lang.classfile.attribute.CodeAttribute;
import java.lang.classfile.attribute.StackMapTableAttribute;
import java.lang.classfile.instruction.ExceptionCatch;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;

import jdk.internal.classfile.impl.BufferedCodeBuilder;

/**
 * Models the body of a method (the {@code Code} attribute).  A {@code Code}
 * attribute is viewed as a {@linkplain CompoundElement composition} of {@link
 * CodeElement}s, which is the only way to access {@link Instruction}s; the
 * order of elements of a code model is significant.
 * <p>
 * A {@code CodeModel} is obtained from {@link MethodModel#code()}, or in the
 * traversal of the member elements of a method.
 * <p>
 * {@link MethodBuilder#withCode} is the main way to build code models.  {@link
 * MethodBuilder#transformCode} and {@link CodeBuilder#transforming} allow
 * creating new {@code Code} attributes by selectively processing the original
 * code elements and directing the results to a code builder.
 * <p>
 * A {@code Code} attribute holds attributes, but they are usually not member
 * elements, but are decomposed to {@link PseudoInstruction}, accessible
 * according to {@link DeadLabelsOption}, {@link DebugElementsOption}, and
 * {@link LineNumbersOption}.  {@link StackMapTableAttribute} can only be
 * accessed via {@linkplain AttributedElement explicit attribute reading}, as it
 * is considered a derived property from the code body.
 *
 * @see MethodModel#code()
 * @see CodeTransform
 * @see CodeAttribute
 * @jvms 4.7.3 The {@code Code} Attribute
 * @since 24
 */
public sealed interface CodeModel
        extends CompoundElement<CodeElement>, AttributedElement, MethodElement
        permits CodeAttribute, BufferedCodeBuilder.Model {

    /**
     * {@return the enclosing method, if known}
     */
    Optional<MethodModel> parent();

    /**
     * {@return the exception table of the method}  The exception table is also
     * modeled by {@link ExceptionCatch} elements in the streaming view.
     */
    List<ExceptionCatch> exceptionHandlers();
}