Module java.base

Package java.lang.foreign

Interface ValueLayout.OfByte

All Superinterfaces:

MemoryLayoutPREVIEW, ValueLayoutPREVIEW

Enclosing interface:

ValueLayoutPREVIEW

public static sealed interface ValueLayout.OfByte
extends ValueLayoutPREVIEW

OfByte is a preview API of the Java platform.

Programs can only use OfByte when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

A value layout whose carrier is byte.class.

Since:

19

See Also:

• ValueLayout.JAVA_BYTE^PREVIEW

Nested Class Summary

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

MemoryLayout.PathElementPREVIEW

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

ValueLayout.OfBooleanPREVIEW, ValueLayout.OfBytePREVIEW, ValueLayout.OfCharPREVIEW, ValueLayout.OfDoublePREVIEW, ValueLayout.OfFloatPREVIEW, ValueLayout.OfIntPREVIEW, ValueLayout.OfLongPREVIEW, ValueLayout.OfShortPREVIEW

Field Summary

Fields declared in interface java.lang.foreign.ValueLayout^PREVIEW

ADDRESS, ADDRESS_UNALIGNED, JAVA_BOOLEAN, JAVA_BYTE, JAVA_CHAR, JAVA_CHAR_UNALIGNED, JAVA_DOUBLE, JAVA_DOUBLE_UNALIGNED, JAVA_FLOAT, JAVA_FLOAT_UNALIGNED, JAVA_INT, JAVA_INT_UNALIGNED, JAVA_LONG, JAVA_LONG_UNALIGNED, JAVA_SHORT, JAVA_SHORT_UNALIGNED

Method Summary

Modifier and Type	Method	Description
ValueLayout.OfBytePREVIEW	withByteAlignment(long byteAlignment)	Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).
ValueLayout.OfBytePREVIEW	withName(String name)	Returns a memory layout with the same characteristics as this layout, but with the given name.
ValueLayout.OfBytePREVIEW	withOrder(ByteOrder order)	Returns a value layout with the same characteristics as this layout, but with the given byte order.
ValueLayout.OfBytePREVIEW	withoutName()	Returns a memory layout with the same characteristics as this layout, but with no name.

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

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

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

arrayElementVarHandle, carrier, order

Method Details

withName

ValueLayout.OfBytePREVIEW withName(String name)

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

Specified by:

withName in interface MemoryLayoutPREVIEW

Specified by:

withName in interface ValueLayoutPREVIEW

Parameters:

name - the layout name.

Returns:

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

See Also:

• MemoryLayout.name()^PREVIEW

withoutName

ValueLayout.OfBytePREVIEW withoutName()

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

Specified by:

withoutName in interface MemoryLayoutPREVIEW

Specified by:

withoutName in interface ValueLayoutPREVIEW

Returns:

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

See Also:

• MemoryLayout.name()^PREVIEW

withByteAlignment

ValueLayout.OfBytePREVIEW withByteAlignment(long byteAlignment)

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

Specified by:

withByteAlignment in interface MemoryLayoutPREVIEW

Specified by:

withByteAlignment in interface ValueLayoutPREVIEW

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 byteAlignment is not a power of two.

withOrder

ValueLayout.OfBytePREVIEW withOrder(ByteOrder order)

Returns a value layout with the same characteristics as this layout, but with the given byte order.

Specified by:

withOrder in interface ValueLayoutPREVIEW

Parameters:

order - the desired byte order.

Returns:

a value layout with the same characteristics as this layout, but with the given byte order