mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-27 14:54:52 +02:00
32ac72c3d3
Co-authored-by: Maurizio Cimadamore <mcimadamore@openjdk.org> Co-authored-by: Jorn Vernee <jvernee@openjdk.org> Co-authored-by: Per Minborg <pminborg@openjdk.org> Reviewed-by: dholmes, psandoz, mcimadamore, alanb
73 lines
2.9 KiB
Java
73 lines
2.9 KiB
Java
/*
|
|
* Copyright (c) 2019, 2023, 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.foreign;
|
|
|
|
import java.util.List;
|
|
|
|
/**
|
|
* A compound layout that is an aggregation of multiple, heterogeneous <em>member layouts</em>. There are two ways in which member layouts
|
|
* can be combined: if member layouts are laid out one after the other, the resulting group layout is a
|
|
* {@linkplain StructLayout struct layout}; conversely, if all member layouts are laid out at the same starting offset,
|
|
* the resulting group layout is a {@linkplain UnionLayout union layout}.
|
|
*
|
|
* @implSpec
|
|
* This class is immutable, thread-safe and <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
|
|
*
|
|
* @sealedGraph
|
|
* @since 22
|
|
*/
|
|
public sealed interface GroupLayout extends MemoryLayout permits StructLayout, UnionLayout {
|
|
|
|
/**
|
|
* {@return the member layouts of this group layout}
|
|
*
|
|
* @apiNote the order in which member layouts are returned is the same order in which member layouts have
|
|
* been passed to one of the group layout factory methods (see {@link MemoryLayout#structLayout(MemoryLayout...)},
|
|
* {@link MemoryLayout#unionLayout(MemoryLayout...)}).
|
|
*/
|
|
List<MemoryLayout> memberLayouts();
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
@Override
|
|
GroupLayout withName(String name);
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
@Override
|
|
GroupLayout withoutName();
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
* @throws IllegalArgumentException {@inheritDoc}
|
|
* @throws IllegalArgumentException if {@code byteAlignment} is less than {@code M}, where {@code M} is the maximum alignment
|
|
* constraint in any of the member layouts associated with this group layout.
|
|
*/
|
|
@Override
|
|
GroupLayout withByteAlignment(long byteAlignment);
|
|
}
|