OpenJDK 27 · jdk.internal.foreign.FunctionDescriptorImpl

Modifier and Type	Field and Description
private final List<MemoryLayout>	argLayouts
private final MemoryLayout	resLayout

Access	Constructor and Description
private	FunctionDescriptorImpl(MemoryLayout resLayout, List<MemoryLayout> argLayouts)

Method Summary

Modifier and Type	Method and Description
public FunctionDescriptorImpl	Returns: the new function descriptor. appendArgumentLayouts(MemoryLayout... the argument layouts to append. addedLayouts) Implements java.lang.foreign.FunctionDescriptor.appendArgumentLayouts. Returns a function descriptor with the given argument layouts appended to the argument layout array of this function descriptor.
public List<MemoryLayout>	Returns: the argument layouts associated with this function descriptor (as an immutable list) argumentLayouts() Implements java.lang.foreign.FunctionDescriptor.argumentLayouts. Returns the argument layouts associated with this function descriptor (as an immutable list).
private static Class<?>	carrierTypeFor(MemoryLayout layout)
public FunctionDescriptorImpl	Returns: the new function descriptor. changeReturnLayout(MemoryLayout the new return layout. newReturn) Implements java.lang.foreign.FunctionDescriptor.changeReturnLayout. Returns a function descriptor with the given memory layout as the new return layout.
public FunctionDescriptorImpl	Returns: the new function descriptor. dropReturnLayout() Implements java.lang.foreign.FunctionDescriptor.dropReturnLayout. Returns a function descriptor with the return layout dropped.
public boolean	Returns: `true` if the specified object is equal to this function descriptor. equals(Object the object to be compared for equality with this function descriptor. other) Overrides java.lang.Object.equals. Compares the specified object with this function descriptor for equality.
public int	Returns: the hash code value for this function descriptor hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this function descriptor.
public FunctionDescriptorImpl	Returns: the new function descriptor. insertArgumentLayouts(int the index at which to insert the arguments index, MemoryLayout... the argument layouts to insert at given index. addedLayouts) Implements java.lang.foreign.FunctionDescriptor.insertArgumentLayouts. Returns a function descriptor with the given argument layouts inserted at the given index, into the argument layout array of this function descriptor.
public static FunctionDescriptor	of(MemoryLayout resLayout, List<MemoryLayout> argLayouts)
public static FunctionDescriptor	ofVoid(List<MemoryLayout> argLayouts)
public Optional<MemoryLayout>	Returns: the return layout (if any) associated with this function descriptor returnLayout() Implements java.lang.foreign.FunctionDescriptor.returnLayout. Returns the return layout (if any) associated with this function descriptor.
public MethodType	toMethodType() Implements java.lang.foreign.FunctionDescriptor.toMethodType. Returns the method type consisting of the carrier types of the layouts in this function descriptor.
public String	Returns: the string representation of this function descriptor toString() Overrides java.lang.Object.toString. Returns the string representation of this function descriptor.

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

argLayouts	back to summary
private final List<MemoryLayout> argLayouts

resLayout	back to summary
private final MemoryLayout resLayout

FunctionDescriptorImpl	back to summary
private FunctionDescriptorImpl(MemoryLayout resLayout, List<MemoryLayout> argLayouts)

Method Detail

appendArgumentLayouts	back to summary
public FunctionDescriptorImpl appendArgumentLayouts(MemoryLayout... addedLayouts) Implements java.lang.foreign.FunctionDescriptor.appendArgumentLayouts. Returns a function descriptor with the given argument layouts appended to the argument layout array of this function descriptor. Parameters addedLayouts:MemoryLayout[] the argument layouts to append. Returns:FunctionDescriptorImpl the new function descriptor.

appendArgumentLayouts

back to summary

public FunctionDescriptorImpl appendArgumentLayouts(MemoryLayout... addedLayouts)

Implements java.lang.foreign.FunctionDescriptor.appendArgumentLayouts.

Returns a function descriptor with the given argument layouts appended to the argument layout array of this function descriptor.

Parameters

addedLayouts:MemoryLayout[]: the argument layouts to append.

Returns:FunctionDescriptorImpl

the new function descriptor.

argumentLayouts	back to summary
public List<MemoryLayout> argumentLayouts() Implements java.lang.foreign.FunctionDescriptor.argumentLayouts. Returns the argument layouts associated with this function descriptor (as an immutable list). . Returns:List<MemoryLayout> the argument layouts associated with this function descriptor (as an immutable list)

argumentLayouts

back to summary

public List<MemoryLayout> argumentLayouts()

Implements java.lang.foreign.FunctionDescriptor.argumentLayouts.

Returns the argument layouts associated with this function descriptor (as an immutable list). .

Returns:List<MemoryLayout>: the argument layouts associated with this function descriptor (as an immutable list)

carrierTypeFor	back to summary
private static Class<?> carrierTypeFor(MemoryLayout layout)

changeReturnLayout	back to summary
public FunctionDescriptorImpl changeReturnLayout(MemoryLayout newReturn) Implements java.lang.foreign.FunctionDescriptor.changeReturnLayout. Returns a function descriptor with the given memory layout as the new return layout. Parameters newReturn:MemoryLayout the new return layout. Returns:FunctionDescriptorImpl the new function descriptor.

changeReturnLayout

back to summary

public FunctionDescriptorImpl changeReturnLayout(MemoryLayout newReturn)

Implements java.lang.foreign.FunctionDescriptor.changeReturnLayout.

Returns a function descriptor with the given memory layout as the new return layout.

Parameters

newReturn:MemoryLayout: the new return layout.

Returns:FunctionDescriptorImpl

the new function descriptor.

dropReturnLayout	back to summary
public FunctionDescriptorImpl dropReturnLayout() Implements java.lang.foreign.FunctionDescriptor.dropReturnLayout. Returns a function descriptor with the return layout dropped. This is useful to model functions which return no values. Returns:FunctionDescriptorImpl the new function descriptor.

dropReturnLayout

back to summary

public FunctionDescriptorImpl dropReturnLayout()

Implements java.lang.foreign.FunctionDescriptor.dropReturnLayout.

Returns a function descriptor with the return layout dropped. This is useful to model functions which return no values.

Returns:FunctionDescriptorImpl: the new function descriptor.

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Compares the specified object with this function descriptor for equality. Returns `true` if and only if the specified object is also a function descriptor, and all the following conditions are met: the two function descriptors have equals return layouts (see `MemoryLayout#equals(Object)`), or both have no return layout; the two function descriptors have argument layouts that are pair-wise equal; and Parameters other:Object the object to be compared for equality with this function descriptor. Returns:boolean `true` if the specified object is equal to this function descriptor. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Compares the specified object with this function descriptor for equality. Returns true if and only if the specified object is also a function descriptor, and all the following conditions are met:

the two function descriptors have equals return layouts (see MemoryLayout#equals(Object)), or both have no return layout;
the two function descriptors have argument layouts that are pair-wise equal; and

Parameters

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

Returns:boolean

true if the specified object is equal to this function descriptor.

Annotations

@Override

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

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code value for this function descriptor.

Returns:int

the hash code value for this function descriptor

Annotations

@Override

insertArgumentLayouts back to summary

insertArgumentLayouts	back to summary
public FunctionDescriptorImpl insertArgumentLayouts(int index, MemoryLayout... addedLayouts) Implements java.lang.foreign.FunctionDescriptor.insertArgumentLayouts. Returns a function descriptor with the given argument layouts inserted at the given index, into the argument layout array of this function descriptor. Parameters index:int the index at which to insert the arguments addedLayouts:MemoryLayout[] the argument layouts to insert at given index. Returns:FunctionDescriptorImpl the new function descriptor. Exceptions IllegalArgumentException: if `index < 0 \|\| index > argumentLayouts().size()`.

public FunctionDescriptorImpl insertArgumentLayouts(int index, MemoryLayout... addedLayouts)

Implements java.lang.foreign.FunctionDescriptor.insertArgumentLayouts.

Returns a function descriptor with the given argument layouts inserted at the given index, into the argument layout array of this function descriptor.

Parameters

index:int: the index at which to insert the arguments
addedLayouts:MemoryLayout[]: the argument layouts to insert at given index.

Returns:FunctionDescriptorImpl

the new function descriptor.

Exceptions

IllegalArgumentException:: if index < 0 || index > argumentLayouts().size().

of	back to summary
public static FunctionDescriptor of(MemoryLayout resLayout, List<MemoryLayout> argLayouts)

ofVoid	back to summary
public static FunctionDescriptor ofVoid(List<MemoryLayout> argLayouts)

returnLayout	back to summary
public Optional<MemoryLayout> returnLayout() Implements java.lang.foreign.FunctionDescriptor.returnLayout. Returns the return layout (if any) associated with this function descriptor. Returns:Optional<MemoryLayout> the return layout (if any) associated with this function descriptor

returnLayout

back to summary

public Optional<MemoryLayout> returnLayout()

Implements java.lang.foreign.FunctionDescriptor.returnLayout.

Returns the return layout (if any) associated with this function descriptor.

Returns:Optional<MemoryLayout>: the return layout (if any) associated with this function descriptor

toMethodType back to summary

toMethodType	back to summary
public MethodType toMethodType() Implements java.lang.foreign.FunctionDescriptor.toMethodType. Doc from java.lang.foreign.FunctionDescriptor.toMethodType. Returns the method type consisting of the carrier types of the layouts in this function descriptor. The carrier type of a layout `L` is determined as follows: If `L` is a `ValueLayout` the carrier type is determined through `ValueLayout#carrier()`. If `L` is a `GroupLayout` or a `SequenceLayout`, the carrier type is `MemorySegment`. Annotations @Override

public MethodType toMethodType()

Implements java.lang.foreign.FunctionDescriptor.toMethodType.

Doc from java.lang.foreign.FunctionDescriptor.toMethodType.

Returns the method type consisting of the carrier types of the layouts in this function descriptor.

The carrier type of a layout L is determined as follows:

If L is a ValueLayout the carrier type is determined through ValueLayout#carrier().
If L is a GroupLayout or a SequenceLayout, the carrier type is MemorySegment.

Annotations

@Override

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

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this function descriptor.

Returns:String

the string representation of this function descriptor

Annotations

@Override

public final Class FunctionDescriptorImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail