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

src/java.base/share/classes/java/lang/classfile/constantpool/ConstantValueEntry.java

50 строк2 KB

Chen Liang

8342468: Improve API documentation for java.lang.classfile.constantpool

08 янв 2025, 06:37

08 янв 2025, 06:37bcefab5

/*
 * 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.constantpool;

import java.lang.classfile.Attributes;
import java.lang.constant.ConstantDesc;

/**
 * Marker interface for constant pool entries that can represent constant values
 * in the {@link Attributes#constantValue() ConstantValue} attribute.
 *
 * @see ConstantPoolBuilder#constantValueEntry
 *      ConstantPoolBuilder::constantValueEntry
 * @sealedGraph
 * @since 24
 */
public sealed interface ConstantValueEntry extends LoadableConstantEntry
        permits DoubleEntry, FloatEntry, IntegerEntry, LongEntry, StringEntry {

    /**
     * {@return the constant value}  The constant value will be an {@link
     * Integer}, {@link Long}, {@link Float}, {@link Double}, or {@link String}.
     *
     * @see ConstantPoolBuilder#constantValueEntry(ConstantDesc)
     */
    @Override
    ConstantDesc constantValue();
}