public Class LayoutPath

private final MemoryLayout layout

MH_ADD_EXACT	back to summary
private static final MethodHandle MH_ADD_EXACT

MH_ADD_SCALED_OFFSET	back to summary
private static final MethodHandle MH_ADD_SCALED_OFFSET

MH_CHECK_ENCL_LAYOUT	back to summary
private static final MethodHandle MH_CHECK_ENCL_LAYOUT

MH_SEGMENT_RESIZE	back to summary
private static final MethodHandle MH_SEGMENT_RESIZE

MH_SLICE	back to summary
private static final MethodHandle MH_SLICE

MH_SLICE_LAYOUT	back to summary
private static final MethodHandle MH_SLICE_LAYOUT

offset	back to summary
private final long offset

strides	back to summary
private final long[] strides

LayoutPath	back to summary
private LayoutPath(MemoryLayout layout, long offset, long[] strides, long[] bounds, MethodHandle[] derefAdapters, LayoutPath enclosing)

Method Detail

addBound	back to summary
private long[] addBound(long maxIndex)

addScaledOffset	back to summary
private static long addScaledOffset(long base, long index, long stride, long bound) Annotations @ForceInline

addStride	back to summary
private long[] addStride(long stride)

badLayoutPath	back to summary
private static IllegalArgumentException badLayoutPath(String cause)

breadcrumbs	back to summary
private String breadcrumbs()

checkEnclosingLayout	back to summary
private static void checkEnclosingLayout(MemorySegment segment, long offset, MemoryLayout enclosing)

checkSequenceBounds	back to summary
private void checkSequenceBounds(SequenceLayout seq, long index)

derefElement	back to summary
public LayoutPath derefElement()

dereferenceHandle	back to summary
public VarHandle dereferenceHandle()

dereferenceHandle	back to summary
public VarHandle dereferenceHandle(boolean adapt)

derefPath	back to summary
private static LayoutPath derefPath(MemoryLayout layout, MethodHandle handle, LayoutPath encl)

groupElement	back to summary
public LayoutPath groupElement(String name)

groupElement	back to summary
public LayoutPath groupElement(long index)

layout	back to summary
public MemoryLayout layout()

layout

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

public MemoryLayout layout()

nestedPath	back to summary
private static LayoutPath nestedPath(MemoryLayout layout, long offset, long[] strides, long[] bounds, MethodHandle[] derefAdapters, LayoutPath encl)

offset	back to summary
public long offset()

offsetHandle	back to summary
public MethodHandle offsetHandle()

requireGroupLayout	back to summary
private GroupLayout requireGroupLayout()

requireLayoutType	back to summary
private <T extends MemoryLayout> T requireLayoutType(Class<T> layoutClass, String name)

requireSequenceLayout	back to summary
private SequenceLayout requireSequenceLayout()

resizeSegment	back to summary
private static MemorySegment resizeSegment(MemorySegment segment)

rootLayout	back to summary
private MemoryLayout rootLayout()

rootPath	back to summary
public static LayoutPath rootPath(MemoryLayout layout)

sequenceElement	back to summary
public LayoutPath sequenceElement()

sequenceElement	back to summary
public LayoutPath sequenceElement(long start, long step)

sequenceElement	back to summary
public LayoutPath sequenceElement(long index)

sliceHandle	back to summary
public MethodHandle sliceHandle()

jdk.internal.foreign back to summary

public final Record LayoutPath.DereferenceElement

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.DereferenceElement

All Implemented Interfaces

Record Components

no record components

Field Summary

Modifier and Type	Field and Description
private static final LayoutPath.DereferenceElement	INSTANCE

Constructor Summary

Access	Constructor and Description
public	DereferenceElement()

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public static MemoryLayout.PathElement	instance()
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

INSTANCE	back to summary
private static final LayoutPath.DereferenceElement INSTANCE

Constructor Detail

DereferenceElement	back to summary
public DereferenceElement()

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public int hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Annotations

@Override

instance	back to summary
public static MemoryLayout.PathElement instance()

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Annotations

@Override

jdk.internal.foreign back to summary

public final Record LayoutPath.GroupElementByIndex

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.GroupElementByIndex

All Implemented Interfaces

Record Components

index:long

Field Summary

Modifier and Type	Field and Description
private final long	index Record Component accessed by index().

Constructor Summary

Access	Constructor and Description
public	GroupElementByIndex(long index)

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public long	index() Record Component getter of index.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

index	back to summary
private final long index Record Component accessed by index().

Constructor Detail

GroupElementByIndex	back to summary
public GroupElementByIndex(long index)

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

index	back to summary
public long index() Record Component getter of index.

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

Annotations

@Override

jdk.internal.foreign back to summary

public final Record LayoutPath.GroupElementByName

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.GroupElementByName

All Implemented Interfaces

Record Components

name:String

Field Summary

Modifier and Type	Field and Description
private final String	name Record Component accessed by name().

Constructor Summary

Access	Constructor and Description
public	GroupElementByName(String name)

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	name() Record Component getter of name.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

name	back to summary
private final String name Record Component accessed by name().

Constructor Detail

GroupElementByName	back to summary
public GroupElementByName(String name)

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

name	back to summary
public String name() Record Component getter of name.

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

Annotations

@Override

jdk.internal.foreign back to summary

public final Record LayoutPath.SequenceElement

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.SequenceElement

All Implemented Interfaces

Record Components

no record components

Field Summary

Modifier and Type	Field and Description
private static final LayoutPath.SequenceElement	INSTANCE

Constructor Summary

Access	Constructor and Description
public	SequenceElement()

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public static MemoryLayout.PathElement	instance()
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

INSTANCE	back to summary
private static final LayoutPath.SequenceElement INSTANCE

Constructor Detail

SequenceElement	back to summary
public SequenceElement()

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

instance	back to summary
public static MemoryLayout.PathElement instance()

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

Annotations

@Override

jdk.internal.foreign back to summary

public final Record LayoutPath.SequenceElementByIndex

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.SequenceElementByIndex

All Implemented Interfaces

Record Components

index:long

Field Summary

Modifier and Type	Field and Description
private final long	index Record Component accessed by index().

Constructor Summary

Access	Constructor and Description
public	SequenceElementByIndex(long index)

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public long	index() Record Component getter of index.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

index	back to summary
private final long index Record Component accessed by index().

Constructor Detail

SequenceElementByIndex	back to summary
public SequenceElementByIndex(long index)

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

index	back to summary
public long index() Record Component getter of index.

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

java.util.function.UnaryOperator, java.util.function.Function, java.lang.foreign.MemoryLayout.PathElement

Annotations

@Override

jdk.internal.foreign back to summary

public final Record LayoutPath.SequenceElementByRange

Class Inheritance

extends Record
implements PathElement, UnaryOperator<LayoutPath>

java.lang.Object
java.lang.Record
jdk.internal.foreign.LayoutPath.SequenceElementByRange

All Implemented Interfaces

Record Components

start:long
step:long

Field Summary

Modifier and Type	Field and Description
private final long	start Record Component accessed by start().
private final long	step Record Component accessed by step().

Constructor Summary

Access	Constructor and Description
public	SequenceElementByRange(long start, long step)

Method Summary

Modifier and Type	Method and Description
public LayoutPath	apply(LayoutPath layoutPath) Implements java.util.function.Function.apply. Applies this function to the given argument.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public long	start() Record Component getter of start.
public long	step() Record Component getter of step.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

start	back to summary
private final long start Record Component accessed by start().

step	back to summary
private final long step Record Component accessed by step().

Constructor Detail

SequenceElementByRange	back to summary
public SequenceElementByRange(long start, long step)

Method Detail

apply

public LayoutPath apply(LayoutPath layoutPath)

Applies this function to the given argument.

Annotations

@Override

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

start	back to summary
public long start() Record Component getter of start.

step	back to summary
public long step() Record Component getter of step.

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.