Module dev.orne.config

Package dev.orne.config.impl

Class PropertiesMutableConfigImpl

java.lang.Object

dev.orne.config.impl.AbstractConfig

dev.orne.config.impl.AbstractMutableConfig

dev.orne.config.impl.AbstractWatchableConfig

dev.orne.config.impl.PropertiesConfigImpl

dev.orne.config.impl.PropertiesMutableConfigImpl

All Implemented Interfaces:

Config, FileMutableConfig, FileWatchableConfig, MutableConfig, WatchableConfig

@API(status=INTERNAL,
     since="1.0")
public class PropertiesMutableConfigImpl
extends PropertiesConfigImpl
implements FileWatchableConfig

Properties based mutable configuration.

Since:

1.0

Version:

1.0, 2025-04

Author:

(w) Iker Hernaez

See Also:

• MutableConfig
• Properties

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
PropertiesMutableConfigImpl(ConfigOptions options, MutableConfigOptions mutableOptions, PropertiesConfigOptions propertyOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addListener(WatchableConfig.Listener listener)	Registers the specified configuration change events listener.
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	save(OutputStream destination)	Saves the configuration properties to the specified output stream.
void	save(Writer destination)	Saves the configuration properties to the specified writer.
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.PropertiesConfigImpl

containsInt, getInt, getKeysInt, getProperties, isEmptyInt

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

getEvents, notifyLocalChanges, 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.FileMutableConfig

save, save, save

Methods inherited from interface dev.orne.config.MutableConfig

set, set, set

Methods inherited from interface dev.orne.config.WatchableConfig

subset

Constructor Details

PropertiesMutableConfigImpl

public PropertiesMutableConfigImpl(ConfigOptions options,
 MutableConfigOptions mutableOptions,
 PropertiesConfigOptions propertyOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

mutableOptions - The mutable configuration builder options.

propertyOptions - The properties based configuration builder options.

Method Details

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)

save

public void save(OutputStream destination)
          throws IOException

Saves the configuration properties to the specified output stream. If the file format requires it, the saved content will be encoded using the default encoding (usually UTF-8).

Specified by:

save in interface FileMutableConfig

Parameters:

destination - The destination output stream.

Throws:

IOException - If an I/O error occurs.

save

public void save(Writer destination)
          throws IOException

Saves the configuration properties to the specified writer.

Specified by:

save in interface FileMutableConfig

Parameters:

destination - The destination writer.

Throws:

IOException - If an I/O error occurs.