APIdia Launch Partner
Top Description Methods
java.lang.foreign

public sealed Interface GroupLayout

extends MemoryLayout
permits StructLayout, UnionLayout
Known Direct Subinterfaces
java.lang.foreign.StructLayout, java.lang.foreign.UnionLayout
Imports
java.util.List
A compound layout that is an aggregation of multiple, heterogeneous member layouts. 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 struct layout; conversely, if all member layouts are laid out at the same starting offset, the resulting group layout is a union layout.

Implementation Specification

This class is immutable, thread-safe and value-based.

Since
22

Method Summary

Modifier and TypeMethod and Description
public List<MemoryLayout>

Returns:

the member layouts of this group layout
memberLayouts()

Returns the member layouts of this group layout.

public GroupLayout
withByteAlignment(long byteAlignment)

Redeclares java.lang.foreign.MemoryLayout.withByteAlignment.

Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).

public GroupLayout
withName(String name)

Redeclares java.lang.foreign.MemoryLayout.withName.

Returns a memory layout with the same characteristics as this layout, but with the given name.

public GroupLayout
withoutName()

Redeclares java.lang.foreign.MemoryLayout.withoutName.

Returns a memory layout with the same characteristics as this layout, but with no name.

Inherited from java.lang.foreign.MemoryLayout:
arrayElementVarHandlebyteAlignmentbyteOffsetbyteOffsetHandlebyteSizeequalshashCodenamepaddingLayoutscalescaleHandleselectsequenceLayoutsliceHandlestructLayouttoStringunionLayoutvarHandle

Method Detail

memberLayoutsback to summary
public List<MemoryLayout> memberLayouts()

Returns the member layouts of this group layout.

API Note

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 MemoryLayout#structLayout(MemoryLayout...) and MemoryLayout#unionLayout(MemoryLayout...)).

Returns:List<MemoryLayout>

the member layouts of this group layout

withByteAlignmentback to summary
public GroupLayout withByteAlignment(long byteAlignment)

Redeclares java.lang.foreign.MemoryLayout.withByteAlignment.

Doc from java.lang.foreign.MemoryLayout.withByteAlignment.

Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).

Annotations
@Override
Exceptions
IllegalArgumentException:
  • if byteAlignment is not a power of two
  • if byteAlignment is less than M, where M is the maximum alignment constraint in any of the member layouts associated with this group layout
withNameback to summary
public GroupLayout withName(String name)

Redeclares java.lang.foreign.MemoryLayout.withName.

Doc from java.lang.foreign.MemoryLayout.withName.

Returns a memory layout with the same characteristics as this layout, but with the given name.

Annotations
@Override
withoutNameback to summary
public GroupLayout withoutName()

Redeclares java.lang.foreign.MemoryLayout.withoutName.

Doc from java.lang.foreign.MemoryLayout.withoutName.

Returns a memory layout with the same characteristics as this layout, but with no name.

Annotations
@Override