com.alanbuttars.commons.config

Class ConfigurationYamlCollectionImpl<C>

java.lang.Object

com.alanbuttars.commons.config.ConfigurationAbstractImpl<C>

com.alanbuttars.commons.config.ConfigurationYamlCollectionImpl<C>

Type Parameters:

C - Collection class type to which the given YAML file will be mapped

All Implemented Interfaces:

Configuration<C>

public class ConfigurationYamlCollectionImpl<C>
extends ConfigurationAbstractImpl<C>

Configuration implementation used for YAML files. Instances of this class accept a single YAML file which is mapped to a collection of a given class type.

Author:

Alan Buttars

Constructor Summary

Constructors

Constructor and Description
ConfigurationYamlCollectionImpl(String sourceId, File configFile, EventBus eventBus, com.fasterxml.jackson.core.type.TypeReference<C> typeReference)

Method Summary

Methods

Modifier and Type	Method and Description
C	load(File configFile) Loads the configuration object from the configuration file.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationYamlCollectionImpl

public ConfigurationYamlCollectionImpl(String sourceId,
                               File configFile,
                               EventBus eventBus,
                               com.fasterxml.jackson.core.type.TypeReference<C> typeReference)
                                throws IOException

Throws:

IOException

Method Detail

load

public C 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