- All Superinterfaces:
MemoryLayoutPREVIEW
,ValueLayoutPREVIEW
- Enclosing interface:
ValueLayoutPREVIEW
OfAddress
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 value layout whose carrier is
MemorySegment.class
.
New instances of this type can be created using ValueLayout.ADDRESS
PREVIEW.
- Since:
- 19
-
Nested Class Summary
Nested classes/interfaces inherited from interface java.lang.foreign.MemoryLayoutPREVIEW
MemoryLayout.PathElementPREVIEW
Nested classes/interfaces inherited from interface java.lang.foreign.ValueLayoutPREVIEW
ValueLayout.OfAddressPREVIEW, ValueLayout.OfBooleanPREVIEW, ValueLayout.OfBytePREVIEW, ValueLayout.OfCharPREVIEW, ValueLayout.OfDoublePREVIEW, ValueLayout.OfFloatPREVIEW, ValueLayout.OfIntPREVIEW, ValueLayout.OfLongPREVIEW, ValueLayout.OfShortPREVIEW
-
Field Summary
Fields inherited from interface java.lang.foreign.ValueLayoutPREVIEW
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 TypeMethodDescriptionReturns an unbounded address layout with the same carrier, alignment constraint, name and order as this address layout, but with the specified pointee layout.boolean
Returnstrue
, if this address layout is an unbounded address layout.withBitAlignment
(long bitAlignment) Returns a memory layout of the same type with the same size and name as this layout, but with the specified alignment constraint (in bits).Returns a memory layout of the same type with the same size and alignment constraint as this layout, but with the specified name.Returns a value layout with the same carrier, alignment constraint and name as this value layout, but with the specified byte order.Methods inherited from interface java.lang.foreign.MemoryLayoutPREVIEW
bitAlignment, bitOffset, bitOffsetHandle, bitSize, byteAlignment, byteOffset, byteOffsetHandle, byteSize, equals, hashCode, name, select, sliceHandle, toString, varHandle
Methods inherited from interface java.lang.foreign.ValueLayoutPREVIEW
arrayElementVarHandle, carrier, order
-
Method Details
-
withName
Returns a memory layout of the same type with the same size and alignment constraint as this layout, but with the specified name.- Specified by:
withName
in interfaceMemoryLayoutPREVIEW
- Specified by:
withName
in interfaceValueLayoutPREVIEW
- Parameters:
name
- the layout name.- Returns:
- a memory layout with the given name.
- See Also:
-
withBitAlignment
Returns a memory layout of the same type with the same size and name as this layout, but with the specified alignment constraint (in bits).- Specified by:
withBitAlignment
in interfaceMemoryLayoutPREVIEW
- Specified by:
withBitAlignment
in interfaceValueLayoutPREVIEW
- Parameters:
bitAlignment
- the layout alignment constraint, expressed in bits.- Returns:
- a memory layout with the given alignment constraint.
-
withOrder
Returns a value layout with the same carrier, alignment constraint and name as this value layout, but with the specified byte order.- Specified by:
withOrder
in interfaceValueLayoutPREVIEW
- Parameters:
order
- the desired byte order.- Returns:
- a value layout with the given byte order.
-
asUnbounded
ValueLayout.OfAddressPREVIEW asUnbounded()Returns an unbounded address layout with the same carrier, alignment constraint, name and order as this address layout, but with the specified pointee layout. An unbounded address layout allow raw addresses to be accessed as memory segmentsPREVIEW whose size is set toLong.MAX_VALUE
. As such, these segments can be used in subsequent access operations.This method is restricted. Restricted methods are unsafe, and, if used incorrectly, their use might crash the JVM or, worse, silently result in memory corruption. Thus, clients should refrain from depending on restricted methods, and use safe and supported functionalities, where possible.
- Returns:
- an unbounded address layout with same characteristics as this layout.
- See Also:
-
isUnbounded
boolean isUnbounded()Returnstrue
, if this address layout is an unbounded address layout..- Returns:
true
, if this address layout is an unbounded address layout
-
OfAddress
when preview features are enabled.