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.PreferencesMutableConfigImpl

All Implemented Interfaces:

Config, MutableConfig, PreferencesMutableConfig, WatchableConfig, EventListener, PreferenceChangeListener

@API(status=INTERNAL,
     since="1.0")
public class PreferencesMutableConfigImpl
extends AbstractWatchableConfig
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(@NotNull ConfigOptions options, @NotNull MutableConfigOptions mutableOptions, @NotNull PreferencesConfigOptions preferencesOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	containsInt(@NotBlank String key)	Returns true if the property with the key passed as argument has been configured in this configuration instance.
void	flush()	Saves the current configuration properties to the source preferences node.
protected String	getInt(@NotBlank String key)	Returns the value of the configuration property as String.
protected @NotNull Stream<String>	getKeysInt()	Returns the configuration property keys contained in this configuration instance .
protected @NotNull Preferences	getPreferences()	Returns the preferences node to use as storage of configuration parameters.
protected boolean	isEmptyInt()	Returns true if this configuration instance contains no property.
protected void	notifyLocalChanges(@NotNull String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
void	preferenceChange(@NotNull PreferenceChangeEvent evt)
protected void	removeInt(@NotBlank String... keys)	Removes the specified configuration properties.
protected void	setInt(@NotBlank String key, @NotNull 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.AbstractWatchableConfig

addListener, getEvents, notifyParentChanges, remove, removeListener, set

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

remove, set, set, set, set

Methods inherited from interface dev.orne.config.WatchableConfig

addListener, removeListener, subset

Constructor Details

PreferencesMutableConfigImpl

@API(status=INTERNAL,
     since="1.0")
public PreferencesMutableConfigImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull 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

getPreferences

@NotNull
protected @NotNull Preferences getPreferences()

Returns the preferences node to use as storage of configuration parameters.

Returns:

The preferences node.

isEmptyInt

protected boolean isEmptyInt()

Returns true if this configuration instance contains no property.

Parent configuration

Specified by:

isEmptyInt in class AbstractConfig

Returns:

Returns true if the configuration contains no property.

containsInt

protected boolean containsInt(@NotBlank
 @NotBlank String key)

Returns true if the property with the key passed as argument has been configured in this configuration instance.

Specified by:

containsInt in class AbstractConfig

Parameters:

key - The configuration property.

Returns:

Returns true if the property has been configured.

getKeysInt

@NotNull
protected @NotNull Stream<String> getKeysInt()

Returns the configuration property keys contained in this configuration instance .

Specified by:

getKeysInt in class AbstractConfig

Returns:

The configuration property keys.

getInt

protected String getInt(@NotBlank
 @NotBlank String key)

Returns the value of the configuration property as String.

Specified by:

getInt in class AbstractConfig

Parameters:

key - The configuration property.

Returns:

The configuration parameter value.

setInt

protected void setInt(@NotBlank
 @NotBlank String key,
 @NotNull
 @NotNull String value)

Sets the value of the specified configuration property.

Specified by:

setInt in class AbstractMutableConfig

Parameters:

key - The configuration property.

value - The value to set

removeInt

protected void removeInt(@NotBlank
 @NotBlank String... keys)

Removes the specified configuration properties.

Specified by:

removeInt in class AbstractMutableConfig

Parameters:

keys - The configuration properties.

preferenceChange

public void preferenceChange(@NotNull
 @NotNull PreferenceChangeEvent evt)

Specified by:

preferenceChange in interface PreferenceChangeListener

notifyLocalChanges

protected void notifyLocalChanges(@NotNull
 @NotNull 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()