Interface OptionsFunc

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("org.javagi.JavaGI")
public interface OptionsFunc
extends FunctionPointer

Functional interface declaration of the OptionsFunc callback.

See Also:

• run(String, OptionType, String)

Method Summary

Modifier and Type	Method	Description
boolean	run(String option, OptionType type, @Nullable String description)	Function used to iterate options.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, int, MemorySegment, MemorySegment) method.
default int	upcall(MemorySegment option, int type, MemorySegment description, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

boolean run(String option,
 OptionType type,
 @Nullable String description)

Function used to iterate options.

Not that description string is not localized.

Parameters:

option - the option name

type - the option JSCOptionType

description - the option description, or null

Returns:

true to stop the iteration, or false otherwise

Since:

2.24

upcall

default int upcall(MemorySegment option,
 int type,
 MemorySegment description,
 MemorySegment userData)

The upcall method is called from native code. The parameters are marshaled and run(String, OptionType, String) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, int, MemorySegment, MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer