Package org.gnome.gio

Class FileMonitor.Builder<B extends FileMonitor.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gio.FileMonitor.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

FileMonitor

public static class FileMonitor.Builder<B extends FileMonitor.Builder<B>>
extends GObject.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
FileMonitor	build()	Finish building the FileMonitor object.
B	onChanged(FileMonitor.ChangedCallback handler)	Emitted when file has been changed.
B	setRateLimit(int rateLimit)	The limit of the monitor to watch for changes, in milliseconds.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public FileMonitor build()

Finish building the FileMonitor object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to FileMonitor.

Overrides:

build in class GObject.Builder<B extends FileMonitor.Builder<B>>

Returns:

a new instance of FileMonitor with the properties that were set in the Builder object.

setRateLimit

public B setRateLimit(int rateLimit)

The limit of the monitor to watch for changes, in milliseconds.

Parameters:

rateLimit - the value for the rate-limit property

Returns:

the Builder instance is returned, to allow method chaining

onChanged

public B onChanged(FileMonitor.ChangedCallback handler)

Emitted when file has been changed.

If using FileMonitorFlags.WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), eventType may be FileMonitorEvent.RENAMED, FileMonitorEvent.MOVED_IN or FileMonitorEvent.MOVED_OUT.

In all cases file will be a child of the monitored directory. For renames, file will be the old name and otherFile is the new name. For "moved in" events, file is the name of the file that appeared and otherFile is the old name that it was moved from (in another directory). For "moved out" events, file is the name of the file that used to be in this directory and otherFile is the name of the file at its new location.

It makes sense to treat FileMonitorEvent.MOVED_IN as equivalent to FileMonitorEvent.CREATED and FileMonitorEvent.MOVED_OUT as equivalent to FileMonitorEvent.DELETED, with extra information. FileMonitorEvent.RENAMED is equivalent to a delete/create pair. This is exactly how the events will be reported in the case that the FileMonitorFlags.WATCH_MOVES flag is not in use.

If using the deprecated flag FileMonitorFlags.SEND_MOVED flag and eventType is FileMonitorEvent.MOVED, file will be set to a GFile containing the old path, and otherFile will be set to a GFile containing the new path.

In all the other cases, otherFile will be set to NULL.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• FileMonitor.ChangedCallback.run(org.gnome.gio.File, org.gnome.gio.File, org.gnome.gio.FileMonitorEvent)