com.alanbuttars.commons.config

Class ConfigurationDirectoryImpl

java.lang.Object

com.alanbuttars.commons.config.ConfigurationAbstractImpl<Map<String,File>>

com.alanbuttars.commons.config.ConfigurationDirectoryImpl

All Implemented Interfaces:

Configuration<Map<String,File>>

public class ConfigurationDirectoryImpl
extends ConfigurationAbstractImpl<Map<String,File>>

Configuration implementation used for directories. Instances of this class maintain a mapping of the relative file path to the directory, like so:

 EventBus eventBus = new EventBusSyncImpl();
 Watch watch = Watch.config().withEventBus(eventBus);
 
 // watches the directory specified in the master YAML under the 'clients' file entry
 ConfigurationDirectoryImpl config = watch.directory("clients");
 
 // grabs watchedDirectory/apple.properties
 File appleFile = config.getValue().get("apple.properties");
 
 // grabs watchedDirectory/google.properties
 File googleFile = config.getValue().get("google.properties");
 
 // grabs watchedDirectory/paypal/venmo.properties
 File venmoFile = config.getValue().get("paypal/venmo.properties");
 
 // grabs watchedDirectory/paypal/braintree.properties
 File braintreeFile = config.getValue().get("paypal/braintree.properties");
 

Author:

Alan Buttars

Constructor Summary

Constructors

Constructor and Description
ConfigurationDirectoryImpl(String sourceId, File configFile, EventBus eventBus)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,File>	load(File configFile) Loads the configuration object from the configuration file.
void	onFileEvent(FileEvent fileEvent) Called when a file event published from the ConfigurationAbstractImpl.eventBus is heard.
protected void	whenConfigFileDeleted(File configFile) Called when the file associated with this object is FileEventType.DELETED.

Methods inherited from class com.alanbuttars.commons.config.ConfigurationAbstractImpl

getEventBus, getSourceId, getValue, init, onFileEventMatch, reload, whenConfigFileCreated, whenConfigFileUpdated

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationDirectoryImpl

public ConfigurationDirectoryImpl(String sourceId,
                          File configFile,
                          EventBus eventBus)
                           throws IOException

Throws:

IOException

Method Detail

onFileEvent

public void onFileEvent(FileEvent fileEvent)
                 throws IOException

Description copied from class: ConfigurationAbstractImpl

Called when a file event published from the ConfigurationAbstractImpl.eventBus is heard.

Overrides:

onFileEvent in class ConfigurationAbstractImpl<Map<String,File>>

Parameters:

fileEvent - Non-null file event which may or may not correspond to this configuration object

Throws:

IOException

whenConfigFileDeleted

protected void whenConfigFileDeleted(File configFile)
                              throws IOException

Description copied from class: ConfigurationAbstractImpl

Called when the file associated with this object is FileEventType.DELETED. By default, this method does nothing.

Overrides:

whenConfigFileDeleted in class ConfigurationAbstractImpl<Map<String,File>>

Throws:

IOException

load

public Map<String,File> load(File configFile)
                      throws IOException

Description copied from interface: Configuration

Loads the configuration object from the configuration file.

Parameters:

configFile - Non-null configuration file

Returns:

Non-null configuration object

Throws:

IOException - On any I/O error while reading the configuration file