public final Class SequenceLayoutImpl

Implements java.lang.foreign.SequenceLayout.elementCount.

Returns the element count of this sequence layout.

Returns:long

the element count of this sequence layout

Implements java.lang.foreign.SequenceLayout.elementLayout.

Returns the element layout associated with this sequence layout.

Returns:MemoryLayout

the element layout associated with this sequence layout

Overrides jdk.internal.foreign.layout.AbstractLayout.equals.

Implements java.lang.foreign.MemoryLayout.equals.

Doc from java.lang.foreign.MemoryLayout.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 constraint. 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. Additionally, two address layouts are considered equal if they also have the same target layout;
• 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.

Annotations

@Override

Implements java.lang.foreign.SequenceLayout.flatten.

Returns a flattened sequence layout. The element layout of the returned sequence layout is the first non-sequence element layout found by recursively traversing the element layouts of this sequence layout. This transformation preserves the layout size; nested sequence layout in this sequence layout will be dropped and their element counts will be incorporated into that of the returned sequence layout. For instance, given a sequence layout of the kind:

var seq = MemoryLayout.sequenceLayout(4, MemoryLayout.sequenceLayout(3, ValueLayout.JAVA_INT));

var flattenedSeq = MemoryLayout.sequenceLayout(12, ValueLayout.JAVA_INT);

Returns:SequenceLayout

a sequence layout with the same size as this layout (but, possibly, with different element count), whose element layout is not a sequence layout.

Overrides jdk.internal.foreign.layout.AbstractLayout.hashCode.

Implements java.lang.foreign.MemoryLayout.hashCode.

Doc from java.lang.foreign.MemoryLayout.hashCode.

Returns the hash code value for this layout.

Annotations

@Override

Overrides jdk.internal.foreign.layout.AbstractLayout.hasNaturalAlignment.

Annotations

@Override

Implements java.lang.foreign.SequenceLayout.reshape.

Re-arrange the elements in this sequence layout into a multi-dimensional sequence layout. The resulting layout is a sequence layout where element layouts in the flattened projection of this sequence layout (see flatten()) are re-arranged into one or more nested sequence layouts according to the provided element counts. This transformation preserves the layout size; that is, multiplying the provided element counts must yield the same element count as the flattened projection of this sequence layout.

For instance, given a sequence layout of the kind:

var seq = MemoryLayout.sequenceLayout(4, MemoryLayout.sequenceLayout(3, ValueLayout.JAVA_INT));

var reshapeSeq = MemoryLayout.sequenceLayout(2, MemoryLayout.sequenceLayout(6, ValueLayout.JAVA_INT));

If one of the provided element count is the special value -1, then the element count in that position will be inferred from the remaining element counts and the element count of the flattened projection of this layout. For instance, a layout equivalent to the above reshapeSeq can also be computed in the following ways:

var reshapeSeqImplicit1 = seq.reshape(-1, 6);
var reshapeSeqImplicit2 = seq.reshape(2, -1);

Parameters

elementCounts:long[]

an array of element counts, of which at most one can be -1.

Returns:SequenceLayout

a sequence layout where element layouts in the flattened projection of this sequence layout (see flatten()) are re-arranged into one or more nested sequence layouts.

Exceptions

IllegalArgumentException:

if two or more element counts are set to -1, or if one or more element count is <= 0 (but other than -1) or, if, after any required inference, multiplying the element counts does not yield the same element count as the flattened projection of this sequence layout.

Implements abstract jdk.internal.foreign.layout.AbstractLayout.toString.

Implements java.lang.foreign.MemoryLayout.toString.

Doc from java.lang.foreign.MemoryLayout.toString.

Returns the string representation of this layout.

Annotations

@Override

Overrides jdk.internal.foreign.layout.AbstractLayout.withByteAlignment.

Implements java.lang.foreign.SequenceLayout.withByteAlignment.

Doc from java.lang.foreign.SequenceLayout.withByteAlignment.

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

Annotations

@Override

Implements java.lang.foreign.SequenceLayout.withElementCount.

Returns a sequence layout with the same element layout, alignment constraints and name as this sequence layout, but with the specified element count.

Parameters

elementCount:long

the new element count.

Returns:SequenceLayout

a sequence layout with the given element count.

Exceptions

IllegalArgumentException:

if elementCount < 0.