Module java.base

Package java.lang.foreign

Interface GroupLayout

所有超级接口:

MemoryLayout预览

所有已知子接口:

StructLayout预览, UnionLayout预览

       public sealed interface GroupLayout extends MemoryLayoutPREVIEW permits StructLayoutPREVIEW, UnionLayoutPREVIEW
      

GroupLayout 是 Java 平台的预览 API。

仅当启用预览功能时，程序才能使用 GroupLayout。

预览功能可能会在将来的版本中被移除，或升级为 Java 平台的永久功能。

一个复合布局，是多个异构 成员布局 的聚合。成员布局可以通过两种方式组合：如果成员布局依次排列，得到的组布局是一个 struct 布局^预览；相反，如果所有成员布局在相同的起始偏移处排列，得到的组布局是一个 union 布局^预览。

实现要求:

该类是不可变的、线程安全的，并且是基于值的。

封闭类层次图:

自 JDK 版本:

19

Nested Class Summary

Nested classes/interfaces declared in interface java.lang.foreign.MemoryLayout^PREVIEW

MemoryLayout.PathElementPREVIEW

Method Summary

Modifier and Type	Method	Description
List<MemoryLayoutPREVIEW>	memberLayouts()	返回此组布局的成员布局。
GroupLayoutPREVIEW	withByteAlignment(long byteAlignment)	返回具有与此布局相同特性的内存布局，但具有给定的对齐约束（以字节为单位）。
GroupLayoutPREVIEW	withName(String name)	返回具有与此布局相同特性的内存布局，但具有给定的名称。
GroupLayoutPREVIEW	withoutName()	返回具有与此布局相同特性的内存布局，但没有名称。

Methods declared in interface java.lang.foreign.MemoryLayout^PREVIEW

byteAlignment, byteOffset, byteOffsetHandle, byteSize, equals, hashCode, name, select, sliceHandle, toString, varHandle

Method Details

memberLayouts

             List<MemoryLayoutPREVIEW> memberLayouts()
            

返回此组布局的成员布局。

API 注释:

返回的成员布局顺序与成员布局传递给组布局工厂方法之一的顺序相同（参见 MemoryLayout.structLayout(MemoryLayout...)^预览，MemoryLayout.unionLayout(MemoryLayout...)^预览）。

返回:

此组布局的成员布局

withName

             GroupLayoutPREVIEW withName(String name)
            

返回具有与此布局相同特性的内存布局，但具有给定的名称。

指定者:

withName 在接口 MemoryLayout预览 中

参数:

name - 布局名称。

返回:

具有与此布局相同特性的内存布局，但具有给定名称

参见:

• MemoryLayout.name()^预览

withoutName

             GroupLayoutPREVIEW withoutName()
            

返回具有与此布局相同特性的内存布局，但没有名称。

指定者:

withoutName 在接口 MemoryLayout预览 中

返回:

具有与此布局相同特性的内存布局，但没有名称

参见:

• MemoryLayout.name()^预览

withByteAlignment

             GroupLayoutPREVIEW withByteAlignment(long byteAlignment)
            

返回具有与此布局相同特性的内存布局，但具有给定的对齐约束（以字节为单位）。

指定者:

withByteAlignment 在接口 MemoryLayout预览 中

参数:

byteAlignment - 布局对齐约束，以字节表示。

返回:

具有与此布局相同特性的内存布局，但具有给定的对齐约束（以字节为单位）

抛出:

IllegalArgumentException - 如果 byteAlignment 不是 2 的幂。

IllegalArgumentException - 如果 byteAlignment 小于 M，其中 M 是与此组布局关联的任何成员布局中的最大对齐约束。