Package org.gnome.gio

Class DBusObjectSkeleton

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.DBusObjectSkeleton

All Implemented Interfaces:

Proxy, DBusObject

@Generated("io.github.jwharm.JavaGI")
public class DBusObjectSkeleton
extends GObject
implements DBusObject

A GDBusObjectSkeleton instance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic and change at runtime.

This type is intended to be used with DBusObjectManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DBusObjectSkeleton.AuthorizeMethodCallback	Functional interface declaration of the AuthorizeMethodCallback callback.
static class	DBusObjectSkeleton.Builder<B extends DBusObjectSkeleton.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	DBusObjectSkeleton.DBusObjectSkeletonClass	Class structure for GDBusObjectSkeleton.

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.DBusObject

DBusObject.DBusObjectIface, DBusObject.DBusObjectImpl, DBusObject.InterfaceAddedCallback, DBusObject.InterfaceRemovedCallback

Constructor Summary

Constructors

Constructor	Description
DBusObjectSkeleton(MemorySegment address)	Create a DBusObjectSkeleton proxy instance for the provided memory address.
DBusObjectSkeleton(String objectPath)	Creates a new GDBusObjectSkeleton.

Method Summary

Modifier and Type	Method	Description
void	addInterface(DBusInterfaceSkeleton interface_)	Adds interface_ to this DBusObjectSkeleton.
protected DBusObjectSkeleton	asParent()	Returns this instance as if it were its parent type.
protected boolean	authorizeMethod(DBusInterfaceSkeleton interface_, DBusMethodInvocation invocation)	Signal class handler for the GDBusObjectSkeleton::authorize-method signal.
static DBusObjectSkeleton.Builder<? extends DBusObjectSkeleton.Builder>	builder()	A DBusObjectSkeleton.Builder object constructs a DBusObjectSkeleton with the specified properties.
boolean	emitAuthorizeMethod(DBusInterfaceSkeleton interface_, DBusMethodInvocation invocation)	Emits the "authorize-method" signal.
void	flush()	This method simply calls g_dbus_interface_skeleton_flush() on all interfaces belonging to this DBusObjectSkeleton.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the DBusObjectSkeleton class
SignalConnection<DBusObjectSkeleton.AuthorizeMethodCallback>	onAuthorizeMethod(DBusObjectSkeleton.AuthorizeMethodCallback handler)	Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized.
void	removeInterface(DBusInterfaceSkeleton interface_)	Removes interface_ from this DBusObjectSkeleton.
void	removeInterfaceByName(String interfaceName)	Removes the GDBusInterface with interfaceName from this DBusObjectSkeleton.
void	setObjectPath(String objectPath)	Sets the object path for this DBusObjectSkeleton.

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, 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 org.gnome.gio.DBusObject

emitInterfaceAdded, emitInterfaceRemoved, getInterface, getInterfaces, getObjectPath, onInterfaceAdded, onInterfaceRemoved

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

handle

Constructor Details

DBusObjectSkeleton

public DBusObjectSkeleton(MemorySegment address)

Create a DBusObjectSkeleton proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DBusObjectSkeleton

public DBusObjectSkeleton(String objectPath)

Creates a new GDBusObjectSkeleton.

Parameters:

objectPath - An object path.

Method Details

getType

public static Type getType()

Get the GType of the DBusObjectSkeleton class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected DBusObjectSkeleton 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(DBusInterfaceSkeleton interface_)

Adds interface_ to this DBusObjectSkeleton.

If this DBusObjectSkeleton already contains a GDBusInterfaceSkeleton with the same interface name, it is removed before interface_ is added.

Note that this DBusObjectSkeleton takes its own reference on interface_ and holds it until removed.

Parameters:

interface_ - A GDBusInterfaceSkeleton.

flush

public void flush()

This method simply calls g_dbus_interface_skeleton_flush() on all interfaces belonging to this DBusObjectSkeleton. See that method for when flushing is useful.

removeInterface

public void removeInterface(DBusInterfaceSkeleton interface_)

Removes interface_ from this DBusObjectSkeleton.

Parameters:

interface_ - A GDBusInterfaceSkeleton.

removeInterfaceByName

public void removeInterfaceByName(String interfaceName)

Removes the GDBusInterface with interfaceName from this DBusObjectSkeleton.

If no D-Bus interface of the given interface exists, this function does nothing.

Parameters:

interfaceName - A D-Bus interface name.

setObjectPath

public void setObjectPath(String objectPath)

Sets the object path for this DBusObjectSkeleton.

Parameters:

objectPath - A valid D-Bus object path.

authorizeMethod

protected boolean authorizeMethod(DBusInterfaceSkeleton interface_,
 DBusMethodInvocation invocation)

Signal class handler for the GDBusObjectSkeleton::authorize-method signal.

onAuthorizeMethod

public SignalConnection<DBusObjectSkeleton.AuthorizeMethodCallback> onAuthorizeMethod(DBusObjectSkeleton.AuthorizeMethodCallback handler)

Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized.

This signal is like GDBusInterfaceSkeleton's GDBusInterfaceSkeleton::g-authorize-method signal, except that it is for the enclosing object.

The default class handler just returns true.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• DBusObjectSkeleton.AuthorizeMethodCallback.run(org.gnome.gio.DBusInterfaceSkeleton, org.gnome.gio.DBusMethodInvocation)

emitAuthorizeMethod

public boolean emitAuthorizeMethod(DBusInterfaceSkeleton interface_,
 DBusMethodInvocation invocation)

Emits the "authorize-method" signal. See onAuthorizeMethod(org.gnome.gio.DBusObjectSkeleton.AuthorizeMethodCallback).

builder

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

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