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, MutableConfig, WatchableConfig

Direct Known Subclasses:

CommonsMutableConfigImpl, JsonMutableConfigImpl, PreferencesMutableConfigImpl, PropertiesMutableConfigImpl, XmlMutableConfigImpl

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

Base abstract implementation of watchable mutable configuration properties provider.

Since:

1.0

Version:

1.0, 2025-04

Author:

(w) Iker Hernaez

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

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

Method Summary

Modifier and Type	Method	Description
void	addListener(@NotNull 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(@NotNull String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
protected void	notifyParentChanges(@NotNull Set<String> keys)	Notifies configuration properties changed through parent configuration to all registered listeners.
void	remove(@NotBlank String... keys)	Removes the specified configuration properties.
void	removeListener(@NotNull WatchableConfig.Listener listener)	Unregisters the specified configuration change events listener.
void	set(@NotBlank String key, 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, 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

AbstractWatchableConfig

protected AbstractWatchableConfig(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull 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

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

Sets the value of the specified configuration property.

Specified by:

set in interface MutableConfig

Overrides:

set in class AbstractMutableConfig

Parameters:

key - The configuration property.

value - The value to set

remove

public void remove(@NotBlank
 @NotBlank String... keys)

Removes the specified configuration properties.

Specified by:

remove in interface MutableConfig

Overrides:

remove in class AbstractMutableConfig

Parameters:

keys - The configuration properties.

addListener

public void addListener(@NotNull
 @NotNull WatchableConfig.Listener listener)

Registers the specified configuration change events listener.

Specified by:

addListener in interface WatchableConfig

Parameters:

listener - The listener to be called on configuration changes.

removeListener

public void removeListener(@NotNull
 @NotNull WatchableConfig.Listener listener)

Unregisters the specified configuration change events listener.

Specified by:

removeListener in interface WatchableConfig

Parameters:

listener - The listener to previously registered.

notifyLocalChanges

protected void notifyLocalChanges(@NotNull
 @NotNull String... keys)

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

Parameters:

keys - The changed local properties.

notifyParentChanges

protected void notifyParentChanges(@NotNull
 @NotNull Set<String> keys)

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

Parameters:

keys - The changed parent properties.