de.aristaflow.adept2.util.configuration

Class AutoSaveListener

java.lang.Object

org.apache.commons.configuration2.io.FileHandlerListenerAdapter

de.aristaflow.adept2.util.configuration.AutoSaveListener

All Implemented Interfaces:

EventListener<ConfigurationEvent>, FileHandlerListener

public class AutoSaveListener
extends FileHandlerListenerAdapter
implements EventListener<ConfigurationEvent>

A listener to automatically save a properties configuration to the corresponding file when changing the configuration. Each change will lead to a complete saving of the file. To prevent cycles, changes occurring while loading or storing the file will not save the configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertiesFileConfiguration	conf The configuration of which to save the contents when changed.
protected int	failedSaves The amount of consecutive failures when saving the file.
protected int	failedSavesWarning The amount of failed saves leading to a warning in the log.
protected java.util.concurrent.locks.ReadWriteLock	fileLock The lock to synchronise file access.
protected java.util.logging.Logger	logger The logger to which to log problems occurring when saving the configuration.
protected java.nio.file.Path	path The path to the configuration file, null in case of a URL.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoSaveListener(PropertiesFileConfiguration conf, FileHandler fileHandler, java.util.logging.Logger logger) Creates a new listener automatically saving a properties configuration to the corresponding file when changing the configuration.
protected	AutoSaveListener(PropertiesFileConfiguration conf, FileHandler fileHandler, java.nio.file.Path path, java.util.logging.Logger logger) Creates a new listener automatically saving a properties configuration to the corresponding file when changing the configuration.

Method Summary

Modifier and Type	Method and Description
void	loaded(FileHandler handler)
void	loading(FileHandler handler)
void	onEvent(ConfigurationEvent event)
protected void	resetCount() Resets the failure and the warning limit count.

Methods inherited from class org.apache.commons.configuration2.io.FileHandlerListenerAdapter

locationChanged, saved, saving

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

conf

protected final PropertiesFileConfiguration conf

The configuration of which to save the contents when changed.

path

protected final java.nio.file.Path path

The path to the configuration file, null in case of a URL.

logger

protected final java.util.logging.Logger logger

The logger to which to log problems occurring when saving the configuration.

fileLock

protected final java.util.concurrent.locks.ReadWriteLock fileLock

The lock to synchronise file access.

failedSaves

protected int failedSaves

The amount of consecutive failures when saving the file. This will be reset after a successful write.

failedSavesWarning

protected int failedSavesWarning

The amount of failed saves leading to a warning in the log. This is doubled each time a waring is logged. This will be reset after a successful write.

Constructor Detail

AutoSaveListener

protected AutoSaveListener(PropertiesFileConfiguration conf,
                           FileHandler fileHandler,
                           java.util.logging.Logger logger)

Creates a new listener automatically saving a properties configuration to the corresponding file when changing the configuration.

Parameters:

conf - The properties configuration of which to save all changes.

fileHandler - The handler for the configuration file.

logger - The logger to log failed saves.

AutoSaveListener

protected AutoSaveListener(PropertiesFileConfiguration conf,
                           FileHandler fileHandler,
                           java.nio.file.Path path,
                           java.util.logging.Logger logger)

Creates a new listener automatically saving a properties configuration to the corresponding file when changing the configuration.

Parameters:

conf - The properties configuration of which to save all changes.

fileHandler - The handler for the configuration file.

path - The path to the configuration file. This will be used to create the file and its parent directories if required. If this is null, the file has to exist and must be writable.

logger - The logger to log failed saves.

Method Detail

onEvent

public void onEvent(ConfigurationEvent event)

Specified by:

onEvent in interface EventListener<ConfigurationEvent>

loading

public void loading(FileHandler handler)

Specified by:

loading in interface FileHandlerListener

Overrides:

loading in class FileHandlerListenerAdapter

loaded

public void loaded(FileHandler handler)

Specified by:

loaded in interface FileHandlerListener

Overrides:

loaded in class FileHandlerListenerAdapter

resetCount

protected void resetCount()

Resets the failure and the warning limit count.