Package org.gnome.gio

Interface Drive

All Superinterfaces:

Proxy

All Known Implementing Classes:

Drive.DriveImpl

@Generated("io.github.jwharm.JavaGI")
public interface Drive
extends Proxy

GDrive represents a piece of hardware connected to the machine. It’s generally only created for removable hardware or hardware with removable media. For example, an optical disc drive, or a USB flash drive.

GDrive is a container class for Volume objects that stem from the same piece of media. As such, GDrive abstracts a drive with (or without) removable media and provides operations for querying whether media is available, determining whether media change is automatically detected and ejecting the media.

If the GDrive reports that media isn’t automatically detected, one can poll for media; typically one should not do this periodically as a poll for media operation is potentially expensive and may spin up the drive creating noise.

GDrive supports starting and stopping drives with authentication support for the former. This can be used to support a diverse set of use cases including connecting/disconnecting iSCSI devices, powering down external disk enclosures and starting/stopping multi-disk devices such as RAID devices. Note that the actual semantics and side-effects of starting/stopping a GDrive may vary according to implementation. To choose the correct verbs in e.g. a file manager, use getStartStopType().

For porting from GnomeVFS note that there is no equivalent of GDrive in that API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Drive.ChangedCallback	Functional interface declaration of the ChangedCallback callback.
static interface	Drive.DisconnectedCallback	Functional interface declaration of the DisconnectedCallback callback.
static class	Drive.DriveIface	Interface for creating GDrive implementations.
static class	Drive.DriveImpl	The DriveImpl type represents a native instance of the Drive interface.
static interface	Drive.EjectButtonCallback	Functional interface declaration of the EjectButtonCallback callback.
static interface	Drive.StopButtonCallback	Functional interface declaration of the StopButtonCallback callback.

Method Summary

Modifier and Type	Method	Description
default boolean	canEject()	Checks if a drive can be ejected.
default boolean	canPollForMedia()	Checks if a drive can be polled for media changes.
default boolean	canStart()	Checks if a drive can be started.
default boolean	canStartDegraded()	Checks if a drive can be started degraded.
default boolean	canStop()	Checks if a drive can be stopped.
default void	eject(Set<MountUnmountFlags> flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Deprecated. Use g_drive_eject_with_operation() instead.
default void	eject(MountUnmountFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Deprecated. Use g_drive_eject_with_operation() instead.
default boolean	ejectFinish(AsyncResult result)	Deprecated. Use g_drive_eject_with_operation_finish() instead.
default void	ejectWithOperation(Set<MountUnmountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Ejects a drive.
default void	ejectWithOperation(MountUnmountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Ejects a drive.
default boolean	ejectWithOperationFinish(AsyncResult result)	Finishes ejecting a drive.
default void	emitChanged()	Emits the "changed" signal.
default void	emitDisconnected()	Emits the "disconnected" signal.
default void	emitEjectButton()	Emits the "eject-button" signal.
default void	emitStopButton()	Emits the "stop-button" signal.
default String[]	enumerateIdentifiers()	Gets the kinds of identifiers that this Drive has.
default Icon	getIcon()	Gets the icon for this Drive.
default String	getIdentifier(String kind)	Gets the identifier of the given kind for this Drive.
default String	getName()	Gets the name of this Drive.
default String	getSortKey()	Gets the sort key for this Drive, if any.
default DriveStartStopType	getStartStopType()	Gets a hint about how a drive can be started/stopped.
default Icon	getSymbolicIcon()	Gets the icon for this Drive.
static Type	getType()	Get the GType of the Drive class
default List<Volume>	getVolumes()	Get a list of mountable volumes for this Drive.
default boolean	hasMedia()	Checks if the this Drive has media.
default boolean	hasVolumes()	Check if this Drive has any mountable volumes.
default boolean	isMediaCheckAutomatic()	Checks if this Drive is capable of automatically detecting media changes.
default boolean	isMediaRemovable()	Checks if the this Drive supports removable media.
default boolean	isRemovable()	Checks if the GDrive and/or its media is considered removable by the user.
default SignalConnection<Drive.ChangedCallback>	onChanged(Drive.ChangedCallback handler)	Emitted when the drive's state has changed.
default SignalConnection<Drive.DisconnectedCallback>	onDisconnected(Drive.DisconnectedCallback handler)	This signal is emitted when the GDrive have been disconnected.
default SignalConnection<Drive.EjectButtonCallback>	onEjectButton(Drive.EjectButtonCallback handler)	Emitted when the physical eject button (if any) of a drive has been pressed.
default SignalConnection<Drive.StopButtonCallback>	onStopButton(Drive.StopButtonCallback handler)	Emitted when the physical stop button (if any) of a drive has been pressed.
default void	pollForMedia(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously polls this Drive to see if media has been inserted or removed.
default boolean	pollForMediaFinish(AsyncResult result)	Finishes an operation started with g_drive_poll_for_media() on a drive.
default void	start(Set<DriveStartFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously starts a drive.
default void	start(DriveStartFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously starts a drive.
default boolean	startFinish(AsyncResult result)	Finishes starting a drive.
default void	stop(Set<MountUnmountFlags> flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously stops a drive.
default void	stop(MountUnmountFlags flags, @Nullable MountOperation mountOperation, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously stops a drive.
default boolean	stopFinish(AsyncResult result)	Finishes stopping a drive.

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

handle

Method Details

getType

static Type getType()

Get the GType of the Drive class

Returns:

the GType

canEject

default boolean canEject()

Checks if a drive can be ejected.

Returns:

true if the this Drive can be ejected, false otherwise.

canPollForMedia

default boolean canPollForMedia()

Checks if a drive can be polled for media changes.

Returns:

true if the this Drive can be polled for media changes, false otherwise.

canStart

default boolean canStart()

Checks if a drive can be started.

Returns:

true if the this Drive can be started, false otherwise.

canStartDegraded

default boolean canStartDegraded()

Checks if a drive can be started degraded.

Returns:

true if the this Drive can be started degraded, false otherwise.

canStop

default boolean canStop()

Checks if a drive can be stopped.

Returns:

true if the this Drive can be stopped, false otherwise.

eject

@Deprecated
default void eject(Set<MountUnmountFlags> flags,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Deprecated.

Use g_drive_eject_with_operation() instead.

Asynchronously ejects a drive.

When the operation is finished, callback will be called. You can then call g_drive_eject_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the unmount if required for eject

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

eject

@Deprecated
default void eject(MountUnmountFlags flags,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Deprecated.

Use g_drive_eject_with_operation() instead.

Asynchronously ejects a drive.

When the operation is finished, callback will be called. You can then call g_drive_eject_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the unmount if required for eject

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

ejectFinish

@Deprecated
default boolean ejectFinish(AsyncResult result)
                     throws GErrorException

Deprecated.

Use g_drive_eject_with_operation_finish() instead.

Finishes ejecting a drive.

Parameters:

result - a GAsyncResult.

Returns:

true if the drive has been ejected successfully, false otherwise.

Throws:

GErrorException - see GError

ejectWithOperation

default void ejectWithOperation(Set<MountUnmountFlags> flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the this Drive and GAsyncResult data returned in the callback.

Parameters:

flags - flags affecting the unmount if required for eject

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

ejectWithOperation

default void ejectWithOperation(MountUnmountFlags flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the this Drive and GAsyncResult data returned in the callback.

Parameters:

flags - flags affecting the unmount if required for eject

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

ejectWithOperationFinish

default boolean ejectWithOperationFinish(AsyncResult result)
                                  throws GErrorException

Finishes ejecting a drive. If any errors occurred during the operation, error will be set to contain the errors and false will be returned.

Parameters:

result - a GAsyncResult.

Returns:

true if the drive was successfully ejected. false otherwise.

Throws:

GErrorException - see GError

enumerateIdentifiers

default String[] enumerateIdentifiers()

Gets the kinds of identifiers that this Drive has. Use g_drive_get_identifier() to obtain the identifiers themselves.

Returns:

a null-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free.

getIcon

default Icon getIcon()

Gets the icon for this Drive.

Returns:

GIcon for the this Drive. Free the returned object with g_object_unref().

getIdentifier

default String getIdentifier(String kind)

Gets the identifier of the given kind for this Drive. The only identifier currently available is G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE.

Parameters:

kind - the kind of identifier to return

Returns:

a newly allocated string containing the requested identifier, or null if the GDrive doesn't have this kind of identifier.

getName

default String getName()

Gets the name of this Drive.

Returns:

a string containing this Drive's name. The returned string should be freed when no longer needed.

getSortKey

default String getSortKey()

Gets the sort key for this Drive, if any.

Returns:

Sorting key for this Drive or null if no such key is available.

getStartStopType

default DriveStartStopType getStartStopType()

Gets a hint about how a drive can be started/stopped.

Returns:

A value from the GDriveStartStopType enumeration.

getSymbolicIcon

default Icon getSymbolicIcon()

Gets the icon for this Drive.

Returns:

symbolic GIcon for the this Drive. Free the returned object with g_object_unref().

getVolumes

default List<Volume> getVolumes()

Get a list of mountable volumes for this Drive.

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

Returns:

GList containing any GVolume objects on the given this Drive.

hasMedia

default boolean hasMedia()

Checks if the this Drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details.

Returns:

true if this Drive has media, false otherwise.

hasVolumes

default boolean hasVolumes()

Check if this Drive has any mountable volumes.

Returns:

true if the this Drive contains volumes, false otherwise.

isMediaCheckAutomatic

default boolean isMediaCheckAutomatic()

Checks if this Drive is capable of automatically detecting media changes.

Returns:

true if the this Drive is capable of automatically detecting media changes, false otherwise.

isMediaRemovable

default boolean isMediaRemovable()

Checks if the this Drive supports removable media.

Returns:

true if this Drive supports removable media, false otherwise.

isRemovable

default boolean isRemovable()

Checks if the GDrive and/or its media is considered removable by the user. See g_drive_is_media_removable().

Returns:

true if this Drive and/or its media is considered removable, false otherwise.

pollForMedia

default void pollForMedia(@Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously polls this Drive to see if media has been inserted or removed.

When the operation is finished, callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the result of the operation.

Parameters:

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

pollForMediaFinish

default boolean pollForMediaFinish(AsyncResult result)
                            throws GErrorException

Finishes an operation started with g_drive_poll_for_media() on a drive.

Parameters:

result - a GAsyncResult.

Returns:

true if the drive has been poll_for_mediaed successfully, false otherwise.

Throws:

GErrorException - see GError

start

default void start(Set<DriveStartFlags> flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously starts a drive.

When the operation is finished, callback will be called. You can then call g_drive_start_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the start operation.

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

start

default void start(DriveStartFlags flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously starts a drive.

When the operation is finished, callback will be called. You can then call g_drive_start_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the start operation.

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

startFinish

default boolean startFinish(AsyncResult result)
                     throws GErrorException

Finishes starting a drive.

Parameters:

result - a GAsyncResult.

Returns:

true if the drive has been started successfully, false otherwise.

Throws:

GErrorException - see GError

stop

default void stop(Set<MountUnmountFlags> flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously stops a drive.

When the operation is finished, callback will be called. You can then call g_drive_stop_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the unmount if required for stopping.

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

stop

default void stop(MountUnmountFlags flags,
 @Nullable
 @Nullable MountOperation mountOperation,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously stops a drive.

When the operation is finished, callback will be called. You can then call g_drive_stop_finish() to obtain the result of the operation.

Parameters:

flags - flags affecting the unmount if required for stopping.

mountOperation - a GMountOperation or null to avoid user interaction.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback, or null.

stopFinish

default boolean stopFinish(AsyncResult result)
                    throws GErrorException

Finishes stopping a drive.

Parameters:

result - a GAsyncResult.

Returns:

true if the drive has been stopped successfully, false otherwise.

Throws:

GErrorException - see GError

onChanged

default SignalConnection<Drive.ChangedCallback> onChanged(Drive.ChangedCallback handler)

Emitted when the drive's state has changed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Drive.ChangedCallback.run()

emitChanged

default void emitChanged()

Emits the "changed" signal. See onChanged(org.gnome.gio.Drive.ChangedCallback).

onDisconnected

default SignalConnection<Drive.DisconnectedCallback> onDisconnected(Drive.DisconnectedCallback handler)

This signal is emitted when the GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Drive.DisconnectedCallback.run()

emitDisconnected

default void emitDisconnected()

Emits the "disconnected" signal. See onDisconnected(org.gnome.gio.Drive.DisconnectedCallback).

onEjectButton

default SignalConnection<Drive.EjectButtonCallback> onEjectButton(Drive.EjectButtonCallback handler)

Emitted when the physical eject button (if any) of a drive has been pressed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Drive.EjectButtonCallback.run()

emitEjectButton

default void emitEjectButton()

Emits the "eject-button" signal. See onEjectButton(org.gnome.gio.Drive.EjectButtonCallback).

onStopButton

default SignalConnection<Drive.StopButtonCallback> onStopButton(Drive.StopButtonCallback handler)

Emitted when the physical stop button (if any) of a drive has been pressed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Drive.StopButtonCallback.run()

emitStopButton

default void emitStopButton()

Emits the "stop-button" signal. See onStopButton(org.gnome.gio.Drive.StopButtonCallback).