org.apache.commons.configuration2.builder

Interface ConfigurationBuilder<T extends Configuration>

Type Parameters:

T - the concrete type of the Configuration class produced by this builder

All Superinterfaces:

EventSource

All Known Implementing Classes:

BasicConfigurationBuilder, CombinedConfigurationBuilder, FileBasedConfigurationBuilder, MultiFileConfigurationBuilder, ReloadingCombinedConfigurationBuilder, ReloadingFileBasedConfigurationBuilder, ReloadingMultiFileConfigurationBuilder

public interface ConfigurationBuilder<T extends Configuration>
extends EventSource

Definition of an interface for objects that can create Configuration objects of a specific type.

This interface defines an abstract way of creating a Configuration object. It does not assume any specific way of how this is done; this is completely in the responsibility of an implementation class. There is just a single method that returns the configuration constructed by this builder.

Since:

2.0

Version:

$Id: ConfigurationBuilder.java 1624601 2014-09-12 18:04:36Z oheger $

Method Summary

Modifier and Type	Method and Description
T	getConfiguration() Returns the configuration provided by this builder.

Methods inherited from interface org.apache.commons.configuration2.event.EventSource

addEventListener, removeEventListener

Method Detail

getConfiguration

T getConfiguration()
            throws ConfigurationException

Returns the configuration provided by this builder. An implementation has to perform all necessary steps for creating and initializing a Configuration object.

Returns:

the configuration

Throws:

ConfigurationException - if an error occurs