OpenJDK 27 · jdk.internal.foreign.layout.AbstractLayout

Modifier and Type	Field and Description
private final long	byteAlignment
private final long	byteSize
private final Optional<String>	name

Access	Constructor and Description
pack-priv	AbstractLayout(long byteSize, long byteAlignment, Optional<String> name)

Method Summary

Modifier and Type	Method and Description
public VarHandle	arrayElementVarHandle(MemoryLayout.PathElement... elements)
public final long	byteAlignment()
public long	byteOffset(MemoryLayout.PathElement... elements)
public MethodHandle	byteOffsetHandle(MemoryLayout.PathElement... elements)
public final long	byteSize()
private static <Z> Z	computePathOp(LayoutPath path, Function<LayoutPath, Z> finalizer, Set<Class<?>> badTypes, MemoryLayout.PathElement... elements)
pack-priv String	decorateLayoutString(String s)
pack-priv abstract L	dup(long byteAlignment, Optional<String> name)
public boolean	Returns: `true` if the specified object is equal to this layout. equals(Object the object to be compared for equality with this layout. other) Overrides java.lang.Object.equals. Compares the specified object with this layout for equality.
public int	Returns: the hash code value for this layout hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this layout.
public boolean	hasNaturalAlignment()
public final Optional<String>	name()
private static long	requirePowerOfTwoAndGreaterOrEqualToOne(long value)
public long	scale(long offset, long index)
public MethodHandle	scaleHandle()
public MemoryLayout	select(MemoryLayout.PathElement... elements)
public MethodHandle	sliceHandle(MemoryLayout.PathElement... elements)
public abstract String	Returns: the string representation of this layout toString() Overrides java.lang.Object.toString. Returns the string representation of this layout.
public VarHandle	varHandle(MemoryLayout.PathElement... elements)
public VarHandle	varHandleInternal(MemoryLayout.PathElement... elements)
public L	withByteAlignment(long byteAlignment)
public final L	withName(String name)
public final L	withoutName()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

byteAlignment	back to summary
private final long byteAlignment

byteSize	back to summary
private final long byteSize

name	back to summary
private final Optional<String> name

AbstractLayout	back to summary
pack-priv AbstractLayout(long byteSize, long byteAlignment, Optional<String> name)

Method Detail

arrayElementVarHandle	back to summary
public VarHandle arrayElementVarHandle(MemoryLayout.PathElement... elements)

byteAlignment	back to summary
public final long byteAlignment()

byteOffset	back to summary
public long byteOffset(MemoryLayout.PathElement... elements)

byteOffsetHandle	back to summary
public MethodHandle byteOffsetHandle(MemoryLayout.PathElement... elements)

byteSize	back to summary
public final long byteSize()

computePathOp	back to summary
private static <Z> Z computePathOp(LayoutPath path, Function<LayoutPath, Z> finalizer, Set<Class<?>> badTypes, MemoryLayout.PathElement... elements)

decorateLayoutString	back to summary
pack-priv String decorateLayoutString(String s)

dup	back to summary
pack-priv abstract L dup(long byteAlignment, Optional<String> name)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Compares the specified object with this layout for equality. Returns `true` if and only if the specified object is also a layout, and it is equal to this layout. Two layouts are considered equal if they are of the same kind, have the same size, name and alignment constraints. Furthermore, depending on the layout kind, additional conditions must be satisfied: two value layouts are considered equal if they have the same order, and carrier two sequence layouts are considered equal if they have the same element count (see `SequenceLayout#elementCount()`), and if their element layouts (see `SequenceLayout#elementLayout()`) are also equal two group layouts are considered equal if they are of the same type (see `StructLayout`, `UnionLayout`) and if their member layouts (see `GroupLayout#memberLayouts()`) are also equal Parameters other:Object the object to be compared for equality with this layout. Returns:boolean `true` if the specified object is equal to this layout. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Compares the specified object with this layout for equality. Returns true if and only if the specified object is also a layout, and it is equal to this layout. Two layouts are considered equal if they are of the same kind, have the same size, name and alignment constraints. Furthermore, depending on the layout kind, additional conditions must be satisfied:

two value layouts are considered equal if they have the same order, and carrier
two sequence layouts are considered equal if they have the same element count (see SequenceLayout#elementCount()), and if their element layouts (see SequenceLayout#elementLayout()) are also equal
two group layouts are considered equal if they are of the same type (see StructLayout, UnionLayout) and if their member layouts (see GroupLayout#memberLayouts()) are also equal

Parameters

other:Object: the object to be compared for equality with this layout.

Returns:boolean

true if the specified object is equal to this layout.

Annotations

@Override

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this layout. Returns:int the hash code value for this layout Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code value for this layout.

Returns:int

the hash code value for this layout

Annotations

@Override

hasNaturalAlignment	back to summary
public boolean hasNaturalAlignment()

name	back to summary
public final Optional<String> name()

requirePowerOfTwoAndGreaterOrEqualToOne	back to summary
private static long requirePowerOfTwoAndGreaterOrEqualToOne(long value)

scale	back to summary
public long scale(long offset, long index)

scaleHandle	back to summary
public MethodHandle scaleHandle()

select	back to summary
public MemoryLayout select(MemoryLayout.PathElement... elements)

sliceHandle	back to summary
public MethodHandle sliceHandle(MemoryLayout.PathElement... elements)

toString	back to summary
public abstract String toString() Overrides java.lang.Object.toString. Returns the string representation of this layout. Returns:String the string representation of this layout Annotations @Override

toString

back to summary

public abstract String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this layout.

Returns:String

the string representation of this layout

Annotations

@Override

varHandle	back to summary
public VarHandle varHandle(MemoryLayout.PathElement... elements)

varHandleInternal	back to summary
public VarHandle varHandleInternal(MemoryLayout.PathElement... elements)

withByteAlignment	back to summary
public L withByteAlignment(long byteAlignment)

withName	back to summary
public final L withName(String name)

withoutName	back to summary
public final L withoutName() Annotations @SuppressWarnings:unchecked

public abstract sealed Class AbstractLayout<L extends AbstractLayout<L> & MemoryLayout>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail