- All Superinterfaces:
- GroupLayoutPREVIEW,- MemoryLayoutPREVIEW
StructLayout is a preview API of the Java platform.
Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.
A group layout whose member layouts are laid out one after the other.
- Implementation Requirements:
- Implementing classes are immutable, thread-safe and value-based.
- Since:
- 20
- 
Nested Class SummaryNested classes/interfaces declared in interface java.lang.foreign.MemoryLayoutPREVIEWMemoryLayout.PathElementPREVIEW
- 
Method SummaryModifier and TypeMethodDescriptionwithByteAlignment(long byteAlignment) Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).Returns a memory layout with the same characteristics as this layout, but with the given name.Returns a memory layout with the same characteristics as this layout, but with no name.Methods declared in interface java.lang.foreign.GroupLayoutPREVIEWmemberLayoutsMethods declared in interface java.lang.foreign.MemoryLayoutPREVIEWbyteAlignment, byteOffset, byteOffsetHandle, byteSize, equals, hashCode, name, select, sliceHandle, toString, varHandle
- 
Method Details- 
withNameReturns a memory layout with the same characteristics as this layout, but with the given name.- Specified by:
- withNamein interface- GroupLayoutPREVIEW
- Specified by:
- withNamein interface- MemoryLayoutPREVIEW
- Parameters:
- name- the layout name.
- Returns:
- a memory layout with the same characteristics as this layout, but with the given name
- See Also:
 
- 
withoutNameStructLayoutPREVIEW withoutName()Returns a memory layout with the same characteristics as this layout, but with no name.- Specified by:
- withoutNamein interface- GroupLayoutPREVIEW
- Specified by:
- withoutNamein interface- MemoryLayoutPREVIEW
- Returns:
- a memory layout with the same characteristics as this layout, but with no name
- See Also:
 
- 
withByteAlignmentReturns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).- Specified by:
- withByteAlignmentin interface- GroupLayoutPREVIEW
- Specified by:
- withByteAlignmentin interface- MemoryLayoutPREVIEW
- Parameters:
- byteAlignment- the layout alignment constraint, expressed in bytes.
- Returns:
- a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes)
- Throws:
- IllegalArgumentException- if- byteAlignmentis not a power of two.
- IllegalArgumentException- if- byteAlignmentis less than- M, where- Mis the maximum alignment constraint in any of the member layouts associated with this group layout.
 
 
- 
StructLayoutwhen preview features are enabled.