Package org.gnome.gio

Class VolumeMonitor

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.VolumeMonitor

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

NativeVolumeMonitor

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

GVolumeMonitor is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar.

GVolumeMonitor is not thread-default-context aware (see MainContext.pushThreadDefault()), and so should not be used other than from the main thread, with no thread-default-context active.

In order to receive updates about volumes and mounts monitored through GVFS, a main loop must be running.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VolumeMonitor.Builder<B extends VolumeMonitor.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	VolumeMonitor.DriveChangedCallback	Functional interface declaration of the DriveChangedCallback callback.
static interface	VolumeMonitor.DriveConnectedCallback	Functional interface declaration of the DriveConnectedCallback callback.
static interface	VolumeMonitor.DriveDisconnectedCallback	Functional interface declaration of the DriveDisconnectedCallback callback.
static interface	VolumeMonitor.DriveEjectButtonCallback	Functional interface declaration of the DriveEjectButtonCallback callback.
static interface	VolumeMonitor.DriveStopButtonCallback	Functional interface declaration of the DriveStopButtonCallback callback.
static interface	VolumeMonitor.MountAddedCallback	Functional interface declaration of the MountAddedCallback callback.
static interface	VolumeMonitor.MountChangedCallback	Functional interface declaration of the MountChangedCallback callback.
static interface	VolumeMonitor.MountPreUnmountCallback	Functional interface declaration of the MountPreUnmountCallback callback.
static interface	VolumeMonitor.MountRemovedCallback	Functional interface declaration of the MountRemovedCallback callback.
static interface	VolumeMonitor.VolumeAddedCallback	Functional interface declaration of the VolumeAddedCallback callback.
static interface	VolumeMonitor.VolumeChangedCallback	Functional interface declaration of the VolumeChangedCallback callback.
static class	VolumeMonitor.VolumeMonitorClass
static interface	VolumeMonitor.VolumeRemovedCallback	Functional interface declaration of the VolumeRemovedCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
VolumeMonitor()	Creates a new VolumeMonitor.
VolumeMonitor(MemorySegment address)	Create a VolumeMonitor proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static Volume	adoptOrphanMount(Mount mount)	Deprecated. Instead of using this function, GVolumeMonitor implementations should instead create shadow mounts with the URI of the mount they intend to adopt.
protected VolumeMonitor	asParent()	Returns this instance as if it were its parent type.
static VolumeMonitor.Builder<? extends VolumeMonitor.Builder>	builder()	A VolumeMonitor.Builder object constructs a VolumeMonitor with the specified properties.
protected void	driveChanged(Drive drive)
protected void	driveConnected(Drive drive)
protected void	driveDisconnected(Drive drive)
protected void	driveEjectButton(Drive drive)
protected void	driveStopButton(Drive drive)
void	emitDriveChanged(@Nullable Drive drive)	Emits the "drive-changed" signal.
void	emitDriveConnected(@Nullable Drive drive)	Emits the "drive-connected" signal.
void	emitDriveDisconnected(@Nullable Drive drive)	Emits the "drive-disconnected" signal.
void	emitDriveEjectButton(@Nullable Drive drive)	Emits the "drive-eject-button" signal.
void	emitDriveStopButton(@Nullable Drive drive)	Emits the "drive-stop-button" signal.
void	emitMountAdded(@Nullable Mount mount)	Emits the "mount-added" signal.
void	emitMountChanged(@Nullable Mount mount)	Emits the "mount-changed" signal.
void	emitMountPreUnmount(@Nullable Mount mount)	Emits the "mount-pre-unmount" signal.
void	emitMountRemoved(@Nullable Mount mount)	Emits the "mount-removed" signal.
void	emitVolumeAdded(@Nullable Volume volume)	Emits the "volume-added" signal.
void	emitVolumeChanged(@Nullable Volume volume)	Emits the "volume-changed" signal.
void	emitVolumeRemoved(@Nullable Volume volume)	Emits the "volume-removed" signal.
static VolumeMonitor	get()	Gets the volume monitor used by gio.
List<Drive>	getConnectedDrives()	Gets a list of drives connected to the system.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable Mount	getMountForUuid(String uuid)	Finds a GMount object by its UUID (see g_mount_get_uuid())
List<Mount>	getMounts()	Gets a list of the mounts on the system.
static @Nullable Type	getType()	Get the GType of the VolumeMonitor class
@Nullable Volume	getVolumeForUuid(String uuid)	Finds a GVolume object by its UUID (see g_volume_get_uuid())
List<Volume>	getVolumes()	Gets a list of the volumes on the system.
protected void	mountAdded(Mount mount)
protected void	mountChanged(Mount mount)
protected void	mountPreUnmount(Mount mount)
protected void	mountRemoved(Mount mount)
SignalConnection<VolumeMonitor.DriveChangedCallback>	onDriveChanged(VolumeMonitor.DriveChangedCallback handler)	Emitted when a drive changes.
SignalConnection<VolumeMonitor.DriveConnectedCallback>	onDriveConnected(VolumeMonitor.DriveConnectedCallback handler)	Emitted when a drive is connected to the system.
SignalConnection<VolumeMonitor.DriveDisconnectedCallback>	onDriveDisconnected(VolumeMonitor.DriveDisconnectedCallback handler)	Emitted when a drive is disconnected from the system.
SignalConnection<VolumeMonitor.DriveEjectButtonCallback>	onDriveEjectButton(VolumeMonitor.DriveEjectButtonCallback handler)	Emitted when the eject button is pressed on drive.
SignalConnection<VolumeMonitor.DriveStopButtonCallback>	onDriveStopButton(VolumeMonitor.DriveStopButtonCallback handler)	Emitted when the stop button is pressed on drive.
SignalConnection<VolumeMonitor.MountAddedCallback>	onMountAdded(VolumeMonitor.MountAddedCallback handler)	Emitted when a mount is added.
SignalConnection<VolumeMonitor.MountChangedCallback>	onMountChanged(VolumeMonitor.MountChangedCallback handler)	Emitted when a mount changes.
SignalConnection<VolumeMonitor.MountPreUnmountCallback>	onMountPreUnmount(VolumeMonitor.MountPreUnmountCallback handler)	May be emitted when a mount is about to be removed.
SignalConnection<VolumeMonitor.MountRemovedCallback>	onMountRemoved(VolumeMonitor.MountRemovedCallback handler)	Emitted when a mount is removed.
SignalConnection<VolumeMonitor.VolumeAddedCallback>	onVolumeAdded(VolumeMonitor.VolumeAddedCallback handler)	Emitted when a mountable volume is added to the system.
SignalConnection<VolumeMonitor.VolumeChangedCallback>	onVolumeChanged(VolumeMonitor.VolumeChangedCallback handler)	Emitted when mountable volume is changed.
SignalConnection<VolumeMonitor.VolumeRemovedCallback>	onVolumeRemoved(VolumeMonitor.VolumeRemovedCallback handler)	Emitted when a mountable volume is removed from the system.
protected void	volumeAdded(Volume volume)
protected void	volumeChanged(Volume volume)
protected void	volumeRemoved(Volume volume)

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, 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

VolumeMonitor

public VolumeMonitor(MemorySegment address)

Create a VolumeMonitor proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VolumeMonitor

public VolumeMonitor()

Creates a new VolumeMonitor.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the VolumeMonitor class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

adoptOrphanMount

@Deprecated
public static Volume adoptOrphanMount(Mount mount)

Deprecated.

Instead of using this function, GVolumeMonitor implementations should instead create shadow mounts with the URI of the mount they intend to adopt. See the proxy volume monitor in gvfs for an example of this. Also see g_mount_is_shadowed(), g_mount_shadow() and g_mount_unshadow() functions.

This function should be called by any GVolumeMonitor implementation when a new GMount object is created that is not associated with a GVolume object. It must be called just before emitting the mountAdded signal.

If the return value is not null, the caller must associate the returned GVolume object with the GMount. This involves returning it in its g_mount_get_volume() implementation. The caller must also listen for the "removed" signal on the returned object and give up its reference when handling that signal

Similarly, if implementing g_volume_monitor_adopt_orphan_mount(), the implementor must take a reference to mount and return it in its g_volume_get_mount() implemented. Also, the implementor must listen for the "unmounted" signal on mount and give up its reference upon handling that signal.

There are two main use cases for this function.

One is when implementing a user space file system driver that reads blocks of a block device that is already represented by the native volume monitor (for example a CD Audio file system driver). Such a driver will generate its own GMount object that needs to be associated with the GVolume object that represents the volume.

The other is for implementing a GVolumeMonitor whose sole purpose is to return GVolume objects representing entries in the users "favorite servers" list or similar.

Parameters:

mount - a GMount object to find a parent for

Returns:

the GVolume object that is the parent for mount or null if no wants to adopt the GMount.

get

public static VolumeMonitor get()

Gets the volume monitor used by gio.

Returns:

a reference to the GVolumeMonitor used by gio. Call g_object_unref() when done with it, after disconnecting any signal handlers.

getConnectedDrives

public List<Drive> getConnectedDrives()

Gets a list of drives connected to the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Returns:

a GList of connected GDrive objects.

getMountForUuid

public @Nullable Mount getMountForUuid(String uuid)

Finds a GMount object by its UUID (see g_mount_get_uuid())

Parameters:

uuid - the UUID to look for

Returns:

a GMount or null if no such mount is available. Free the returned object with g_object_unref().

getMounts

public List<Mount> getMounts()

Gets a list of the mounts on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Returns:

a GList of GMount objects.

getVolumeForUuid

public @Nullable Volume getVolumeForUuid(String uuid)

Finds a GVolume object by its UUID (see g_volume_get_uuid())

Parameters:

uuid - the UUID to look for

Returns:

a GVolume or null if no such volume is available. Free the returned object with g_object_unref().

getVolumes

public List<Volume> getVolumes()

Gets a list of the volumes on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Returns:

a GList of GVolume objects.

driveChanged

protected void driveChanged(Drive drive)

driveConnected

protected void driveConnected(Drive drive)

driveDisconnected

protected void driveDisconnected(Drive drive)

driveEjectButton

protected void driveEjectButton(Drive drive)

driveStopButton

protected void driveStopButton(Drive drive)

mountAdded

protected void mountAdded(Mount mount)

mountChanged

protected void mountChanged(Mount mount)

mountPreUnmount

protected void mountPreUnmount(Mount mount)

mountRemoved

protected void mountRemoved(Mount mount)

volumeAdded

protected void volumeAdded(Volume volume)

volumeChanged

protected void volumeChanged(Volume volume)

volumeRemoved

protected void volumeRemoved(Volume volume)

onDriveChanged

public SignalConnection<VolumeMonitor.DriveChangedCallback> onDriveChanged(VolumeMonitor.DriveChangedCallback handler)

Emitted when a drive changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.DriveChangedCallback.run(org.gnome.gio.Drive)

emitDriveChanged

public void emitDriveChanged(@Nullable Drive drive)

Emits the "drive-changed" signal. See onDriveChanged(org.gnome.gio.VolumeMonitor.DriveChangedCallback).

onDriveConnected

public SignalConnection<VolumeMonitor.DriveConnectedCallback> onDriveConnected(VolumeMonitor.DriveConnectedCallback handler)

Emitted when a drive is connected to the system.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.DriveConnectedCallback.run(org.gnome.gio.Drive)

emitDriveConnected

public void emitDriveConnected(@Nullable Drive drive)

Emits the "drive-connected" signal. See onDriveConnected(org.gnome.gio.VolumeMonitor.DriveConnectedCallback).

onDriveDisconnected

public SignalConnection<VolumeMonitor.DriveDisconnectedCallback> onDriveDisconnected(VolumeMonitor.DriveDisconnectedCallback handler)

Emitted when a drive is disconnected from the system.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.DriveDisconnectedCallback.run(org.gnome.gio.Drive)

emitDriveDisconnected

public void emitDriveDisconnected(@Nullable Drive drive)

Emits the "drive-disconnected" signal. See onDriveDisconnected(org.gnome.gio.VolumeMonitor.DriveDisconnectedCallback).

onDriveEjectButton

public SignalConnection<VolumeMonitor.DriveEjectButtonCallback> onDriveEjectButton(VolumeMonitor.DriveEjectButtonCallback handler)

Emitted when the eject button is pressed on drive.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.18

See Also:

• VolumeMonitor.DriveEjectButtonCallback.run(org.gnome.gio.Drive)

emitDriveEjectButton

public void emitDriveEjectButton(@Nullable Drive drive)

Emits the "drive-eject-button" signal. See onDriveEjectButton(org.gnome.gio.VolumeMonitor.DriveEjectButtonCallback).

onDriveStopButton

public SignalConnection<VolumeMonitor.DriveStopButtonCallback> onDriveStopButton(VolumeMonitor.DriveStopButtonCallback handler)

Emitted when the stop button is pressed on drive.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.22

See Also:

• VolumeMonitor.DriveStopButtonCallback.run(org.gnome.gio.Drive)

emitDriveStopButton

public void emitDriveStopButton(@Nullable Drive drive)

Emits the "drive-stop-button" signal. See onDriveStopButton(org.gnome.gio.VolumeMonitor.DriveStopButtonCallback).

onMountAdded

public SignalConnection<VolumeMonitor.MountAddedCallback> onMountAdded(VolumeMonitor.MountAddedCallback handler)

Emitted when a mount is added.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.MountAddedCallback.run(org.gnome.gio.Mount)

emitMountAdded

public void emitMountAdded(@Nullable Mount mount)

Emits the "mount-added" signal. See onMountAdded(org.gnome.gio.VolumeMonitor.MountAddedCallback).

onMountChanged

public SignalConnection<VolumeMonitor.MountChangedCallback> onMountChanged(VolumeMonitor.MountChangedCallback handler)

Emitted when a mount changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.MountChangedCallback.run(org.gnome.gio.Mount)

emitMountChanged

public void emitMountChanged(@Nullable Mount mount)

Emits the "mount-changed" signal. See onMountChanged(org.gnome.gio.VolumeMonitor.MountChangedCallback).

onMountPreUnmount

public SignalConnection<VolumeMonitor.MountPreUnmountCallback> onMountPreUnmount(VolumeMonitor.MountPreUnmountCallback handler)

May be emitted when a mount is about to be removed.

This signal depends on the backend and is only emitted if GIO was used to unmount.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.MountPreUnmountCallback.run(org.gnome.gio.Mount)

emitMountPreUnmount

public void emitMountPreUnmount(@Nullable Mount mount)

Emits the "mount-pre-unmount" signal. See onMountPreUnmount(org.gnome.gio.VolumeMonitor.MountPreUnmountCallback).

onMountRemoved

public SignalConnection<VolumeMonitor.MountRemovedCallback> onMountRemoved(VolumeMonitor.MountRemovedCallback handler)

Emitted when a mount is removed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.MountRemovedCallback.run(org.gnome.gio.Mount)

emitMountRemoved

public void emitMountRemoved(@Nullable Mount mount)

Emits the "mount-removed" signal. See onMountRemoved(org.gnome.gio.VolumeMonitor.MountRemovedCallback).

onVolumeAdded

public SignalConnection<VolumeMonitor.VolumeAddedCallback> onVolumeAdded(VolumeMonitor.VolumeAddedCallback handler)

Emitted when a mountable volume is added to the system.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.VolumeAddedCallback.run(org.gnome.gio.Volume)

emitVolumeAdded

public void emitVolumeAdded(@Nullable Volume volume)

Emits the "volume-added" signal. See onVolumeAdded(org.gnome.gio.VolumeMonitor.VolumeAddedCallback).

onVolumeChanged

public SignalConnection<VolumeMonitor.VolumeChangedCallback> onVolumeChanged(VolumeMonitor.VolumeChangedCallback handler)

Emitted when mountable volume is changed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.VolumeChangedCallback.run(org.gnome.gio.Volume)

emitVolumeChanged

public void emitVolumeChanged(@Nullable Volume volume)

Emits the "volume-changed" signal. See onVolumeChanged(org.gnome.gio.VolumeMonitor.VolumeChangedCallback).

onVolumeRemoved

public SignalConnection<VolumeMonitor.VolumeRemovedCallback> onVolumeRemoved(VolumeMonitor.VolumeRemovedCallback handler)

Emitted when a mountable volume is removed from the system.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• VolumeMonitor.VolumeRemovedCallback.run(org.gnome.gio.Volume)

emitVolumeRemoved

public void emitVolumeRemoved(@Nullable Volume volume)

Emits the "volume-removed" signal. See onVolumeRemoved(org.gnome.gio.VolumeMonitor.VolumeRemovedCallback).

builder

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

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

Returns:

the builder object