Module dev.orne.config

Package dev.orne.config.impl

Class AbstractWatchableConfig

java.lang.Object

dev.orne.config.impl.AbstractConfig

dev.orne.config.impl.AbstractMutableConfig

dev.orne.config.impl.AbstractWatchableConfig

All Implemented Interfaces:

Config

Direct Known Subclasses:

CommonsConfigImpl, JsonConfigImpl, PreferencesConfigImpl, PropertiesConfigImpl, XmlConfigImpl

@API(status=INTERNAL,
     since="1.0")
public abstract class AbstractWatchableConfig
extends AbstractMutableConfig

Base abstract implementation of watchable mutable configuration properties provider.

Extending classes must add WatchableConfig interface and override addListener and removeListener methods making them public and delegating to the protected methods of this class.

Since:

1.0

Version:

1.0, 2025-04

Author:

(w) Iker Hernaez

Field Summary

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

KEY_BLANK_ERR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWatchableConfig(ConfigOptions options)	Creates a new instance.
protected	AbstractWatchableConfig(ConfigOptions options, MutableConfigOptions mutableOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	addListener(WatchableConfig.Listener listener)	Registers the specified configuration change events listener.
protected EventsHandler	getEvents()	Returns the configuration change events handler, if supported by delegated configuration.
protected void	notifyLocalChanges(String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
protected void	notifyParentChanges(Set<String> keys)	Notifies configuration properties changed through parent configuration to all registered listeners.
protected void	remove(String... keys)	Removes the specified configuration properties.
protected void	removeListener(WatchableConfig.Listener listener)	Unregisters the specified configuration change events listener.
protected void	set(String key, @Nullable String value)	Sets the value of the specified configuration property.

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

getEncoder, removeInt, setInt

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

contains, containsInt, get, getDecoder, getDecorator, getInt, getKeys, getKeysInt, getParent, getResolver, getUndecored, isEmpty, isEmptyInt, 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, get, get, getBoolean, getBoolean, getBoolean, getInteger, getInteger, getInteger, getKeys, getKeys, getLong, getLong, getLong, subset

Constructor Details

AbstractWatchableConfig

protected AbstractWatchableConfig(ConfigOptions options)

Creates a new instance.

Parameters:

options - The configuration builder options.

AbstractWatchableConfig

protected AbstractWatchableConfig(ConfigOptions options,
 MutableConfigOptions mutableOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

mutableOptions - The mutable configuration builder options.

Method Details

getEvents

protected EventsHandler getEvents()

Returns the configuration change events handler, if supported by delegated configuration.

Returns:

The configuration change events handler.

set

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

Sets the value of the specified configuration property.

Overrides:

set in class AbstractMutableConfig

Parameters:

key - The configuration property.

value - The value to set

See Also:

• MutableConfig.set(String, String)

remove

protected void remove(String... keys)

Removes the specified configuration properties.

Overrides:

remove in class AbstractMutableConfig

Parameters:

keys - The configuration properties.

See Also:

• MutableConfig.remove(String...)

addListener

protected void addListener(WatchableConfig.Listener listener)

Registers the specified configuration change events listener.

Parameters:

listener - The listener to be called on configuration changes.

Throws:

IllegalStateException - If the configuration type does not support event listeners.

See Also:

• WatchableConfig.addListener(Listener)

removeListener

protected void removeListener(WatchableConfig.Listener listener)

Unregisters the specified configuration change events listener.

Parameters:

listener - The listener to previously registered.

See Also:

• WatchableConfig.removeListener(Listener)

notifyLocalChanges

protected void notifyLocalChanges(String... keys)

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

Parameters:

keys - The changed local properties.

notifyParentChanges

protected void notifyParentChanges(Set<String> keys)

Notifies configuration properties changed through parent configuration to all registered listeners.

Parameters:

keys - The changed parent properties.