Package org.gnome.gobject

Class TypeModule

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.TypeModule

All Implemented Interfaces:

Proxy, TypePlugin

Direct Known Subclasses:

IOModule, TypeModule.TypeModuleImpl

@Generated("io.github.jwharm.JavaGI")
public abstract class TypeModule
extends GObject
implements TypePlugin

GTypeModule provides a simple implementation of the GTypePlugin interface.

The model of GTypeModule is a dynamically loaded module which implements some number of types and interface implementations.

When the module is loaded, it registers its types and interfaces using registerType(org.gnome.glib.Type, java.lang.String, org.gnome.gobject.TypeInfo, java.util.Set<org.gnome.gobject.TypeFlags>) and addInterface(org.gnome.glib.Type, org.gnome.glib.Type, org.gnome.gobject.InterfaceInfo). As long as any instances of these types and interface implementations are in use, the module is kept loaded. When the types and interfaces are gone, the module may be unloaded. If the types and interfaces become used again, the module will be reloaded. Note that the last reference cannot be released from within the module code, since that would lead to the caller's code being unloaded before g_object_unref() returns to it.

Keeping track of whether the module should be loaded or not is done by using a use count - it starts at zero, and whenever it is greater than zero, the module is loaded. The use count is maintained internally by the type system, but also can be explicitly controlled by TypeModule#use and unuse(). Typically, when loading a module for the first type, g_type_module_use() will be used to load it so that it can initialize its types. At some later point, when the module no longer needs to be loaded except for the type implementations it contains, g_type_module_unuse() is called.

GTypeModule does not actually provide any implementation of module loading and unloading. To create a particular module type you must derive from GTypeModule and implement the load and unload functions in GTypeModuleClass.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeModule.Builder<B extends TypeModule.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	TypeModule.TypeModuleClass	In order to implement dynamic loading of types based on GTypeModule, the load and unload functions in GTypeModuleClass must be implemented.
static class	TypeModule.TypeModuleImpl	The TypeModuleImpl type represents a native instance of the abstract TypeModule class.

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gobject.TypePlugin

TypePlugin.TypePluginImpl

Constructor Summary

Constructors

Constructor	Description
TypeModule(MemorySegment address)	Create a TypeModule proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addInterface(Type instanceType, Type interfaceType, InterfaceInfo interfaceInfo)	Registers an additional interface for a type, whose interface lives in the given type plugin.
protected TypeModule	asParent()	Returns this instance as if it were its parent type.
static TypeModule.Builder<? extends TypeModule.Builder>	builder()	A TypeModule.Builder object constructs a TypeModule with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the TypeModule class
protected boolean	load()	loads the module and registers one or more types using g_type_module_register_type().
Type	registerEnum(String name, EnumValue[] constStaticValues)	Looks up or registers an enumeration that is implemented with a particular type plugin.
Type	registerFlags(String name, FlagsValue[] constStaticValues)	Looks up or registers a flags type that is implemented with a particular type plugin.
Type	registerType(Type parentType, String typeName, TypeInfo typeInfo, Set<TypeFlags> flags)	Looks up or registers a type that is implemented with a particular type plugin.
Type	registerType(Type parentType, String typeName, TypeInfo typeInfo, TypeFlags... flags)	Looks up or registers a type that is implemented with a particular type plugin.
void	setName(String name)	Sets the name for a GTypeModule
protected void	unload()	unloads the module
void	unuse()	Decreases the use count of a GTypeModule by one.
boolean	useTypeModule()	Increases the use count of a GTypeModule by one.

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, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gobject.TypePlugin

completeInterfaceInfo, completeTypeInfo, use

Constructor Details

TypeModule

public TypeModule(MemorySegment address)

Create a TypeModule proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the TypeModule class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected TypeModule 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

addInterface

public void addInterface(Type instanceType,
 Type interfaceType,
 InterfaceInfo interfaceInfo)

Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if this TypeModule is null this will call g_type_add_interface_static() instead. This can be used when making a static build of the module.

Parameters:

instanceType - type to which to add the interface.

interfaceType - interface type to add

interfaceInfo - type information structure

registerEnum

public Type registerEnum(String name,
 EnumValue[] constStaticValues)

Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name typeName was previously registered, the GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if this TypeModule is null this will call g_type_register_static() instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

constStaticValues - an array of GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerFlags

public Type registerFlags(String name,
 FlagsValue[] constStaticValues)

Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name typeName was previously registered, the GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if this TypeModule is null this will call g_type_register_static() instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

constStaticValues - an array of GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerType

public Type registerType(Type parentType,
 String typeName,
 TypeInfo typeInfo,
 Set<TypeFlags> flags)

Looks up or registers a type that is implemented with a particular type plugin. If a type with name typeName was previously registered, the GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), this TypeModule and parentType must be the same as they were previously.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if this TypeModule is null this will call g_type_register_static() instead. This can be used when making a static build of the module.

Parameters:

parentType - the type for the parent class

typeName - name for the type

typeInfo - type information structure

flags - flags field providing details about the type

Returns:

the new or existing type ID

registerType

public Type registerType(Type parentType,
 String typeName,
 TypeInfo typeInfo,
 TypeFlags... flags)

Looks up or registers a type that is implemented with a particular type plugin. If a type with name typeName was previously registered, the GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), this TypeModule and parentType must be the same as they were previously.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if this TypeModule is null this will call g_type_register_static() instead. This can be used when making a static build of the module.

Parameters:

parentType - the type for the parent class

typeName - name for the type

typeInfo - type information structure

flags - flags field providing details about the type

Returns:

the new or existing type ID

setName

public void setName(String name)

Sets the name for a GTypeModule

Parameters:

name - a human-readable name to use in error messages.

unuse

public void unuse()

Decreases the use count of a GTypeModule by one. If the result is zero, the module will be unloaded. (However, the GTypeModule will not be freed, and types associated with the GTypeModule are not unregistered. Once a GTypeModule is initialized, it must exist forever.)

Specified by:

unuse in interface TypePlugin

useTypeModule

public boolean useTypeModule()

Increases the use count of a GTypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value.

Returns:

false if the plugin needed to be loaded and loading the plugin failed.

load

protected boolean load()

loads the module and registers one or more types using g_type_module_register_type().

unload

protected void unload()

unloads the module

builder

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

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