Interface OptionParseFunc

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 OptionParseFunc
extends FunctionPointer

Functional interface declaration of the OptionParseFunc callback.

See Also:

• run(OptionContext, OptionGroup, MemorySegment)

Method Summary

Modifier and Type	Method	Description
boolean	run(OptionContext context, OptionGroup group, @Nullable MemorySegment data)	The type of function that can be called before and after parsing.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment, MemorySegment) method.
default int	upcall(MemorySegment context, MemorySegment group, MemorySegment data, MemorySegment _gerrorPointer)	The upcall method is called from native code.

Method Details

run

boolean run(OptionContext context,
 OptionGroup group,
 @Nullable MemorySegment data)
     throws GErrorException

The type of function that can be called before and after parsing.

Parameters:

context - The active GOptionContext

group - The group to which the function belongs

data - User data added to the GOptionGroup containing the option when it was created with g_option_group_new()

Returns:

true if the function completed successfully, false if an error occurred, in which case error should be set with g_set_error()

Throws:

GErrorException - see GError

upcall

default int upcall(MemorySegment context,
 MemorySegment group,
 MemorySegment data,
 MemorySegment _gerrorPointer)

The upcall method is called from native code. The parameters are marshaled and run(OptionContext, OptionGroup, MemorySegment) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, MemorySegment, 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