Module dev.orne.config

Package dev.orne.config.impl

Class CommonsMutableConfigImpl

java.lang.Object

dev.orne.config.impl.AbstractConfig

dev.orne.config.impl.AbstractMutableConfig

dev.orne.config.impl.AbstractWatchableConfig

dev.orne.config.impl.CommonsConfigImpl

dev.orne.config.impl.CommonsMutableConfigImpl

All Implemented Interfaces:

Config, MutableConfig, WatchableConfig

@API(status=INTERNAL,
     since="1.0")
public class CommonsMutableConfigImpl
extends CommonsConfigImpl
implements WatchableConfig

Implementation of MutableConfig based on Apache Commons Configuration.

Since:

0.2

Version:

1.0, 2020-09

Author:

(w) Iker Hernaez

See Also:

• Configuration

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
CommonsMutableConfigImpl(ConfigOptions options, MutableConfigOptions mutableOptions, CommonsConfigOptions commonsOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addListener(WatchableConfig.Listener listener)	Registers the specified configuration change events listener.
protected void	configureCommonsEvents(org.apache.commons.configuration2.event.EventSource source)	Configures reception of Apache Commons events.
protected org.apache.commons.configuration2.Configuration	getConfig()	Returns the delegated Apache Commons configuration.
protected boolean	isLocalEventsSuppressed()	Returns true if local events must be suppressed.
protected void	notifyLocalChanges(String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
protected void	processCommonsEvent(org.apache.commons.configuration2.event.Event event)	Processes the specified Apache Commons event.
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.

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

containsInt, getInt, getKeysInt, 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

CommonsMutableConfigImpl

public CommonsMutableConfigImpl(ConfigOptions options,
 MutableConfigOptions mutableOptions,
 CommonsConfigOptions commonsOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

mutableOptions - The mutable configuration builder options.

commonsOptions - The Apache Commons based configuration options.

Method Details

getConfig

protected org.apache.commons.configuration2.Configuration getConfig()

Returns the delegated Apache Commons configuration.

Overrides:

getConfig in class CommonsConfigImpl

Returns:

The delegated Apache Commons configuration

isLocalEventsSuppressed

protected boolean isLocalEventsSuppressed()

Returns true if local events must be suppressed.

Returns:

If local events must be suppressed.

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)

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.

configureCommonsEvents

protected void configureCommonsEvents(org.apache.commons.configuration2.event.EventSource source)

Configures reception of Apache Commons events.

Parameters:

source - The Apache Commons events source.

processCommonsEvent

protected void processCommonsEvent(org.apache.commons.configuration2.event.Event event)

Processes the specified Apache Commons event.

Parameters:

event - The Apache Commons event.