Package org.gnome.gio

Class Settings.Builder<B extends Settings.Builder<B>>

java.lang.Object

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

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

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

Settings

public static class Settings.Builder<B extends Settings.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
Settings	build()	Finish building the Settings object.
B	onChanged(@Nullable String detail, Settings.ChangedCallback handler)	The "changed" signal is emitted when a key has potentially changed.
B	onChangeEvent(Settings.ChangeEventCallback handler)	The "change-event" signal is emitted once per change event that affects this settings object.
B	onWritableChanged(@Nullable String detail, Settings.WritableChangedCallback handler)	The "writable-changed" signal is emitted when the writability of a key has potentially changed.
B	onWritableChangeEvent(Settings.WritableChangeEventCallback handler)	The "writable-change-event" signal is emitted once per writability change event that affects this settings object.
B	setBackend(SettingsBackend backend)	The name of the context that the settings are stored in.
B	setPath(String path)	The path within the backend where the settings are stored.
B	setSchema(String schema)	Deprecated.
B	setSchemaId(String schemaId)	The name of the schema that describes the types of keys for this GSettings object.
B	setSettingsSchema(SettingsSchema settingsSchema)	The GSettingsSchema describing the types of keys for this GSettings object.

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 Settings build()

Finish building the Settings 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 Settings.

Overrides:

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

Returns:

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

setBackend

public B setBackend(SettingsBackend backend)

The name of the context that the settings are stored in.

Parameters:

backend - the value for the backend property

Returns:

the Builder instance is returned, to allow method chaining

setPath

public B setPath(String path)

The path within the backend where the settings are stored.

Parameters:

path - the value for the path property

Returns:

the Builder instance is returned, to allow method chaining

setSchema

@Deprecated
public B setSchema(String schema)

Deprecated.

The name of the schema that describes the types of keys for this GSettings object.

The type of this property is not GSettingsSchema. GSettingsSchema has only existed since version 2.32 and unfortunately this name was used in previous versions to refer to the schema ID rather than the schema itself. Take care to use the 'settings-schema' property if you wish to pass in a GSettingsSchema.

Parameters:

schema - the value for the schema property

Returns:

the Builder instance is returned, to allow method chaining

setSchemaId

public B setSchemaId(String schemaId)

The name of the schema that describes the types of keys for this GSettings object.

Parameters:

schemaId - the value for the schema-id property

Returns:

the Builder instance is returned, to allow method chaining

setSettingsSchema

public B setSettingsSchema(SettingsSchema settingsSchema)

The GSettingsSchema describing the types of keys for this GSettings object.

Ideally, this property would be called 'schema'. GSettingsSchema has only existed since version 2.32, however, and before then the 'schema' property was used to refer to the ID of the schema rather than the schema itself. Take care.

Parameters:

settingsSchema - the value for the settings-schema property

Returns:

the Builder instance is returned, to allow method chaining

onChangeEvent

public B onChangeEvent(Settings.ChangeEventCallback handler)

The "change-event" signal is emitted once per change event that affects this settings object. You should connect to this signal only if you are interested in viewing groups of changes before they are split out into multiple emissions of the "changed" signal. For most use cases it is more appropriate to use the "changed" signal.

In the event that the change event applies to one or more specified keys, keys will be an array of GQuark of length nKeys. In the event that the change event applies to the GSettings object as a whole (ie: potentially every key has been changed) then keys will be null and nKeys will be 0.

The default handler for this signal invokes the "changed" signal for each affected key. If any other connected handler returns true then this default functionality will be suppressed.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Settings.ChangeEventCallback.run(org.gnome.glib.Quark[])

onChanged

public B onChanged(@Nullable
 @Nullable String detail,
 Settings.ChangedCallback handler)

The "changed" signal is emitted when a key has potentially changed. You should call one of the g_settings_get() calls to check the new value.

This signal supports detailed connections. You can connect to the detailed signal "changed::x" in order to only receive callbacks when key "x" changes.

Note that settings only emits this signal if you have read key at least once while a signal handler was already connected for key.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Settings.ChangedCallback.run(java.lang.String)

onWritableChangeEvent

public B onWritableChangeEvent(Settings.WritableChangeEventCallback handler)

The "writable-change-event" signal is emitted once per writability change event that affects this settings object. You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the "writable-changed" signal. For most use cases it is more appropriate to use the "writable-changed" signal.

In the event that the writability change applies only to a single key, key will be set to the GQuark for that key. In the event that the writability change affects the entire settings object, key will be 0.

The default handler for this signal invokes the "writable-changed" and "changed" signals for each affected key. This is done because changes in writability might also imply changes in value (if for example, a new mandatory setting is introduced). If any other connected handler returns true then this default functionality will be suppressed.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Settings.WritableChangeEventCallback.run(int)

onWritableChanged

public B onWritableChanged(@Nullable
 @Nullable String detail,
 Settings.WritableChangedCallback handler)

The "writable-changed" signal is emitted when the writability of a key has potentially changed. You should call g_settings_is_writable() in order to determine the new status.

This signal supports detailed connections. You can connect to the detailed signal "writable-changed::x" in order to only receive callbacks when the writability of "x" changes.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Settings.WritableChangedCallback.run(java.lang.String)