Package org.webkitgtk.jsc

Class WeakValue

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.jsc.WeakValue

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class WeakValue
extends GObject

JSCWeakValue represents a weak reference to a value in a JSCContext. It can be used to keep a reference to a JavaScript value without protecting it from being garbage collected and without referencing the JSCContext either.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WeakValue.Builder<B extends WeakValue.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	WeakValue.ClearedCallback	Functional interface declaration of the ClearedCallback callback.
static class	WeakValue.WeakValueClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
WeakValue()	Creates a new WeakValue.
WeakValue(MemorySegment address)	Create a WeakValue proxy instance for the provided memory address.
WeakValue(Value value)	Create a new JSCWeakValue for the JavaScript value referenced by value.

Method Summary

Modifier and Type	Method	Description
protected WeakValue	asParent()	Returns this instance as if it were its parent type.
static WeakValue.Builder<? extends WeakValue.Builder>	builder()	A WeakValue.Builder object constructs a WeakValue with the specified properties.
void	emitCleared()	Emits the "cleared" signal.
static @Nullable Type	getType()	Get the GType of the WeakValue class
Value	getValue()	Get a JSCValue referencing the JavaScript value of weakValue.
SignalConnection<WeakValue.ClearedCallback>	onCleared(WeakValue.ClearedCallback handler)	This signal is emitted when the JavaScript value is destroyed.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WeakValue

public WeakValue(MemorySegment address)

Create a WeakValue proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

WeakValue

public WeakValue(Value value)

Create a new JSCWeakValue for the JavaScript value referenced by value.

Parameters:

value - a JSCValue

WeakValue

public WeakValue()

Creates a new WeakValue.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the WeakValue class

Returns:

the GType

asParent

protected WeakValue asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getValue

public Value getValue()

Get a JSCValue referencing the JavaScript value of weakValue.

Returns:

a new JSCValue or null if this WeakValue was cleared.

onCleared

public SignalConnection<WeakValue.ClearedCallback> onCleared(WeakValue.ClearedCallback handler)

This signal is emitted when the JavaScript value is destroyed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WeakValue.ClearedCallback.run()

emitCleared

public void emitCleared()

Emits the "cleared" signal. See onCleared(org.webkitgtk.jsc.WeakValue.ClearedCallback).

builder

public static WeakValue.Builder<? extends WeakValue.Builder> builder()

A WeakValue.Builder object constructs a WeakValue with the specified properties. Use the various set...() methods to set properties, and finish construction with WeakValue.Builder.build().

Returns:

the builder object