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

All Implemented Interfaces:

Config, MutableConfig, WatchableConfig

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

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

Method Summary

Modifier and Type	Method	Description
protected void	configureCommonsEvents(@NotNull org.apache.commons.configuration2.event.EventSource source)	Configures reception of Apache Commons events.
protected boolean	containsInt(@NotBlank String key)	Returns true if the property with the key passed as argument has been configured in this configuration instance.
protected @NotNull org.apache.commons.configuration2.Configuration	getConfig()	Returns the delegated Apache Commons configuration.
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 boolean	isEmptyInt()	Returns true if this configuration instance contains no property.
protected boolean	isLocalEventsSuppressed()	Returns true if local events must be suppressed.
protected void	notifyLocalChanges(@NotNull String... keys)	Notifies configuration properties changed through this instance to all registered listeners.
protected void	processCommonsEvent(@NotNull org.apache.commons.configuration2.event.Event event)	Processes the specified Apache Commons event.
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.

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

set, set, set

Methods inherited from interface dev.orne.config.WatchableConfig

subset

Constructor Details

CommonsMutableConfigImpl

public CommonsMutableConfigImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull 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

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

Returns the delegated Apache Commons configuration.

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.

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.

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.

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.

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.

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.

configureCommonsEvents

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

Configures reception of Apache Commons events.

Parameters:

source - The Apache Commons events source.

processCommonsEvent

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

Processes the specified Apache Commons event.

Parameters:

event - The Apache Commons event.