Modifier and Type	Class and Description
public static record	LinkerOptions.CaptureCallState
public static record	LinkerOptions.Critical
public static record	LinkerOptions.FirstVariadicArg
public static interface	LinkerOptions.LinkerOptionImpl

Modifier and Type	Field and Description
private static final LinkerOptions	EMPTY
private final Map<Class<?>, LinkerOptions.LinkerOptionImpl>	optionsMap

Access	Constructor and Description
private	LinkerOptions(Map<Class<?>, LinkerOptions.LinkerOptionImpl> optionsMap)

Method Summary

Modifier and Type	Method and Description
public boolean	allowsHeapAccess()
public Stream<CapturableState>	capturedCallState()
public static LinkerOptions	empty()
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	firstVariadicArgIndex()
public static LinkerOptions	forDowncall(FunctionDescriptor desc, Linker.Option... options)
private static LinkerOptions	forShared(BiConsumer<LinkerOptions.LinkerOptionImpl, FunctionDescriptor> validator, FunctionDescriptor desc, Linker.Option... options)
public static LinkerOptions	forUpcall(FunctionDescriptor desc, Linker.Option[] options)
private <T extends Linker.Option> T	getOption(Class<T> type)
public boolean	hasCapturedCallState()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isCritical()
public boolean	isVarargsIndex(int argIndex)
public boolean	isVariadicFunction()

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

Field Detail

EMPTY	back to summary
private static final LinkerOptions EMPTY

optionsMap	back to summary
private final Map<Class<?>, LinkerOptions.LinkerOptionImpl> optionsMap

Constructor Detail

LinkerOptions	back to summary
private LinkerOptions(Map<Class<?>, LinkerOptions.LinkerOptionImpl> optionsMap)

Method Detail

allowsHeapAccess	back to summary
public boolean allowsHeapAccess()

capturedCallState	back to summary
public Stream<CapturableState> capturedCallState()

empty	back to summary
public static LinkerOptions empty()

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

firstVariadicArgIndex	back to summary
public int firstVariadicArgIndex()

forDowncall	back to summary
public static LinkerOptions forDowncall(FunctionDescriptor desc, Linker.Option... options)

forShared	back to summary
private static LinkerOptions forShared(BiConsumer<LinkerOptions.LinkerOptionImpl, FunctionDescriptor> validator, FunctionDescriptor desc, Linker.Option... options)

forUpcall	back to summary
public static LinkerOptions forUpcall(FunctionDescriptor desc, Linker.Option[] options)

getOption	back to summary
private <T extends Linker.Option> T getOption(Class<T> type)

hasCapturedCallState	back to summary
public boolean hasCapturedCallState()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isCritical	back to summary
public boolean isCritical()

isVarargsIndex	back to summary
public boolean isVarargsIndex(int argIndex)

isVariadicFunction	back to summary
public boolean isVariadicFunction()

jdk.internal.foreign.abi back to summary

public final Record LinkerOptions.CaptureCallState

Class Inheritance

extends Record
implements LinkerOptionImpl

java.lang.Object
java.lang.Record
jdk.internal.foreign.abi.LinkerOptions.CaptureCallState

All Implemented Interfaces

jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl, java.lang.foreign.Linker.Option

Record Components

saved:Set<CapturableState>

Field Summary

Modifier and Type	Field and Description
private final Set<CapturableState>	saved Record Component accessed by saved().

Constructor Summary

Access	Constructor and Description
public	CaptureCallState(Set<CapturableState> saved)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object the reference object with which to compare. 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 Set<CapturableState>	saved() Record Component getter of saved.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public void	validateForDowncall(FunctionDescriptor descriptor) Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Field Detail

saved	back to summary
private final Set<CapturableState> saved Record Component accessed by saved().

Constructor Detail

CaptureCallState	back to summary
public CaptureCallState(Set<CapturableState> saved)

Method Detail

equals back to summary

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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

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).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from 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. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from 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.

Returns:int: a hash code value for this record.

saved	back to summary
public Set<CapturableState> saved() Record Component getter of saved.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. 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. Returns:String a string representation of the object.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

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.

Returns:String: a string representation of the object.

validateForDowncall	back to summary
public void validateForDowncall(FunctionDescriptor descriptor) Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall. Annotations @Override

validateForDowncall

back to summary

public void validateForDowncall(FunctionDescriptor descriptor)

Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Annotations

@Override

jdk.internal.foreign.abi back to summary

public final Record LinkerOptions.Critical

Class Inheritance

extends Record
implements LinkerOptionImpl

java.lang.Object
java.lang.Record
jdk.internal.foreign.abi.LinkerOptions.Critical

All Implemented Interfaces

jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl, java.lang.foreign.Linker.Option

Record Components

allowHeapAccess:boolean

Field Summary

Modifier and Type	Field and Description
public static LinkerOptions.Critical	ALLOW_HEAP
private final boolean	allowHeapAccess Record Component accessed by allowHeapAccess().
public static LinkerOptions.Critical	DONT_ALLOW_HEAP

Constructor Summary

Access	Constructor and Description
public	Critical(boolean allowHeapAccess)

Method Summary

Modifier and Type	Method and Description
public boolean	allowHeapAccess() Record Component getter of allowHeapAccess.
public final boolean	equals(Object the reference object with which to compare. 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 final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public void	validateForDowncall(FunctionDescriptor descriptor) Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Field Detail

ALLOW_HEAP	back to summary
public static LinkerOptions.Critical ALLOW_HEAP

allowHeapAccess	back to summary
private final boolean allowHeapAccess Record Component accessed by allowHeapAccess().

DONT_ALLOW_HEAP	back to summary
public static LinkerOptions.Critical DONT_ALLOW_HEAP

Constructor Detail

Critical	back to summary
public Critical(boolean allowHeapAccess)

Method Detail

allowHeapAccess	back to summary
public boolean allowHeapAccess() Record Component getter of allowHeapAccess.

equals back to summary

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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

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).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from 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. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns:int: a hash code value for this record.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. 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. Returns:String a string representation of the object.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns:String: a string representation of the object.

validateForDowncall	back to summary
public void validateForDowncall(FunctionDescriptor descriptor) Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall. Annotations @Override

validateForDowncall

back to summary

public void validateForDowncall(FunctionDescriptor descriptor)

Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Annotations

@Override

jdk.internal.foreign.abi back to summary

public final Record LinkerOptions.FirstVariadicArg

Class Inheritance

extends Record
implements LinkerOptionImpl

java.lang.Object
java.lang.Record
jdk.internal.foreign.abi.LinkerOptions.FirstVariadicArg

All Implemented Interfaces

jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl, java.lang.foreign.Linker.Option

Record Components

index:int

Field Summary

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

Constructor Summary

Access	Constructor and Description
public	FirstVariadicArg(int index)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object the reference object with which to compare. 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 int	index() Record Component getter of index.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public void	validateForDowncall(FunctionDescriptor descriptor) Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Field Detail

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

Constructor Detail

FirstVariadicArg	back to summary
public FirstVariadicArg(int index)

Method Detail

equals back to summary

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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

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).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from 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. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns:int: a hash code value for this record.

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

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns:String: a string representation of the object.

validateForDowncall

back to summary

public void validateForDowncall(FunctionDescriptor descriptor)

Overrides default jdk.internal.foreign.abi.LinkerOptions.LinkerOptionImpl.validateForDowncall.

Annotations

@Override

public Class LinkerOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record LinkerOptions.CaptureCallState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record LinkerOptions.Critical

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record LinkerOptions.FirstVariadicArg

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Interface LinkerOptions.LinkerOptionImpl

Method Summary

Method Detail

Modifier and Type	Method and Description
public default void	validateForDowncall(FunctionDescriptor descriptor)
public default void	validateForUpcall(FunctionDescriptor descriptor)