Module dev.orne.config

Package dev.orne.config.impl

Class PreferencesMutableConfigImpl

java.lang.Object

dev.orne.config.impl.AbstractConfig

dev.orne.config.impl.AbstractMutableConfig

dev.orne.config.impl.AbstractWatchableConfig

dev.orne.config.impl.PreferencesConfigImpl

dev.orne.config.impl.PreferencesMutableConfigImpl

All Implemented Interfaces:

Config, MutableConfig, PreferencesMutableConfig, WatchableConfig, EventListener, PreferenceChangeListener

@API(status=INTERNAL,
     since="1.0")
public class PreferencesMutableConfigImpl
extends PreferencesConfigImpl
implements PreferencesMutableConfig, PreferenceChangeListener

Implementation of MutableConfig based on Java Preferences.

Since:

0.1

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• MutableConfig
• Preferences

Nested Class Summary

Nested classes/interfaces inherited from interface dev.orne.config.WatchableConfig

WatchableConfig.Listener

Field Summary

Fields inherited from class dev.orne.config.impl.AbstractConfig

KEY_BLANK_ERR

Constructor Summary

Constructors

Constructor	Description
PreferencesMutableConfigImpl(ConfigOptions options, MutableConfigOptions mutableOptions, PreferencesConfigOptions preferencesOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addListener(WatchableConfig.Listener listener)	Registers the specified configuration change events listener.
void	flush()	Saves the current configuration properties to the source preferences node.
protected void	notifyLocalChanges(String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
void	preferenceChange(PreferenceChangeEvent evt)
void	remove(String... keys)	Removes the specified configuration properties.
protected void	removeInt(String... keys)	Removes the specified configuration properties.
void	removeListener(WatchableConfig.Listener listener)	Unregisters the specified configuration change events listener.
void	set(String key, @Nullable String value)	Sets the value of the specified configuration property.
protected void	setInt(String key, String value)	Sets the value of the specified configuration property.
void	sync()	Synchronizes the configuration properties from the source preferences node.

Methods inherited from class dev.orne.config.impl.PreferencesConfigImpl

containsInt, getInt, getKeysInt, getPreferences, isEmptyInt

Methods inherited from class dev.orne.config.impl.AbstractWatchableConfig

getEvents, notifyParentChanges

Methods inherited from class dev.orne.config.impl.AbstractMutableConfig

getEncoder

Methods inherited from class dev.orne.config.impl.AbstractConfig

contains, get, getDecoder, getDecorator, getKeys, getParent, getResolver, getUndecored, isEmpty, isOverrideParentProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.orne.config.Config

as, contains, get, get, get, getBoolean, getBoolean, getBoolean, getInteger, getInteger, getInteger, getKeys, getKeys, getKeys, getLong, getLong, getLong, getParent, getUndecored, isEmpty

Methods inherited from interface dev.orne.config.MutableConfig

set, set, set

Methods inherited from interface dev.orne.config.WatchableConfig

subset

Constructor Details

PreferencesMutableConfigImpl

public PreferencesMutableConfigImpl(ConfigOptions options,
 MutableConfigOptions mutableOptions,
 PreferencesConfigOptions preferencesOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

mutableOptions - The mutable configuration builder options.

preferencesOptions - The preferences based configuration builder options.

Method Details

set

public void set(String key,
 @Nullable String value)

Sets the value of the specified configuration property.

Specified by:

set in interface MutableConfig

Overrides:

set in class AbstractWatchableConfig

Parameters:

key - The configuration property.

value - The value to set

See Also:

• MutableConfig.set(String, String)

setInt

protected void setInt(String key,
 String value)

Sets the value of the specified configuration property.

Overrides:

setInt in class AbstractMutableConfig

Parameters:

key - The configuration property.

value - The value to set

remove

public void remove(String... keys)

Removes the specified configuration properties.

Specified by:

remove in interface MutableConfig

Overrides:

remove in class AbstractWatchableConfig

Parameters:

keys - The configuration properties.

See Also:

• MutableConfig.remove(String...)

removeInt

protected void removeInt(String... keys)

Removes the specified configuration properties.

Overrides:

removeInt in class AbstractMutableConfig

Parameters:

keys - The configuration properties.

addListener

public void addListener(WatchableConfig.Listener listener)

Registers the specified configuration change events listener.

Specified by:

addListener in interface WatchableConfig

Overrides:

addListener in class AbstractWatchableConfig

Parameters:

listener - The listener to be called on configuration changes.

See Also:

• WatchableConfig.addListener(Listener)

removeListener

public void removeListener(WatchableConfig.Listener listener)

Unregisters the specified configuration change events listener.

Specified by:

removeListener in interface WatchableConfig

Overrides:

removeListener in class AbstractWatchableConfig

Parameters:

listener - The listener to previously registered.

See Also:

• WatchableConfig.removeListener(Listener)

preferenceChange

public void preferenceChange(PreferenceChangeEvent evt)

Specified by:

preferenceChange in interface PreferenceChangeListener

notifyLocalChanges

protected void notifyLocalChanges(String... keys)

Notifies configuration properties changed through this instance to all registered listeners.

Overrides:

notifyLocalChanges in class AbstractWatchableConfig

Parameters:

keys - The changed local properties.

sync

public void sync()

Synchronizes the configuration properties from the source preferences node.

Specified by:

sync in interface PreferencesMutableConfig

See Also:

• Preferences.sync()

flush

public void flush()

Saves the current configuration properties to the source preferences node.

Specified by:

flush in interface PreferencesMutableConfig

See Also:

• Preferences.flush()