Package org.gnome.glib

Interface TraverseFunc

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("io.github.jwharm.JavaGI")
public interface TraverseFunc
extends FunctionPointer

Functional interface declaration of the TraverseFunc callback.

See Also:

• run(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment)

Method Summary

Modifier and Type	Method	Description
boolean	run(@Nullable MemorySegment key, @Nullable MemorySegment value, @Nullable MemorySegment data)	Specifies the type of function passed to g_tree_traverse().
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.
default int	upcall(MemorySegment key, MemorySegment value, MemorySegment data)	The upcall method is called from native code.

Method Details

run

boolean run(@Nullable MemorySegment key,
 @Nullable MemorySegment value,
 @Nullable MemorySegment data)

Specifies the type of function passed to g_tree_traverse(). It is passed the key and value of each node, together with the userData parameter passed to g_tree_traverse(). If the function returns true, the traversal is stopped.

upcall

default int upcall(MemorySegment key,
 MemorySegment value,
 MemorySegment data)

The upcall method is called from native code. The parameters are marshaled and run(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer