Package space.arim.dazzleconf.helper

Class ConfigurationHelper<C>

java.lang.Object

space.arim.dazzleconf.helper.ConfigurationHelper<C>

Type Parameters:

C - the type of the configuration

public class ConfigurationHelper<C>
extends Object

Simple helper class designed to assist in reloading a configuration

Author:

A248

Constructor Summary

Constructors

Constructor	Description
ConfigurationHelper(Path configFolder, String fileName, ConfigurationFactory<C> factory)	Creates from an enclosing directory, filename within that directory, and ConfigurationFactory.

Method Summary

Modifier and Type	Method	Description
ConfigurationFactory<C>	getFactory()	Gets the configuration factory
C	reloadConfigData()	Loads/reloads the configuration data.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationHelper

public ConfigurationHelper(Path configFolder,
 String fileName,
 ConfigurationFactory<C> factory)

Creates from an enclosing directory, filename within that directory, and ConfigurationFactory.

The configuration path will be located at configFolder.resolve(fileName)

Parameters:

configFolder - the enclosing directory

fileName - the filename within the directory

factory - the configuration factory

Method Details

getFactory

public ConfigurationFactory<C> getFactory()

Gets the configuration factory

Returns:

the configuration factory

reloadConfigData

public C reloadConfigData()
                   throws IOException,
InvalidConfigException

Loads/reloads the configuration data. If necessary, updates the config on the filesystem with the latest keys

Returns:

the loaded config data

Throws:

IOException - if an I/O exception occurred

InvalidConfigException - if the loaded configuration was not valid (user error)