Package org.apache.commons.configuration

Class DefaultConfigurationBuilder.FileConfigurationProvider

java.lang.Object

org.apache.commons.configuration.beanutils.DefaultBeanFactory

org.apache.commons.configuration.DefaultConfigurationBuilder.ConfigurationProvider

org.apache.commons.configuration.DefaultConfigurationBuilder.FileConfigurationProvider

All Implemented Interfaces:

BeanFactory

Direct Known Subclasses:

DefaultConfigurationBuilder.XMLConfigurationProvider

Enclosing class:

DefaultConfigurationBuilder

public static class DefaultConfigurationBuilder.FileConfigurationProvider
extends DefaultConfigurationBuilder.ConfigurationProvider

A specialized provider implementation that deals with file based configurations. Ensures that the base path is correctly set and that the load() method gets called.

Field Summary

Fields inherited from class org.apache.commons.configuration.beanutils.DefaultBeanFactory

INSTANCE

Constructor Summary

Constructors

Constructor	Description
FileConfigurationProvider()	Creates a new instance of FileConfigurationProvider.
FileConfigurationProvider(java.lang.Class<?> configClass)	Creates a new instance of FileConfigurationProvider and sets the configuration class.
FileConfigurationProvider(java.lang.String configClassName)	Creates a new instance of FileConfigurationProvider and sets the configuration class name.

Method Summary

Modifier and Type	Method	Description
AbstractConfiguration	getConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)	Creates the configuration.
AbstractConfiguration	getEmptyConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)	Returns an uninitialized file configuration.
protected void	initBeanInstance(java.lang.Object bean, BeanDeclaration data)	Initializes the bean instance.

Methods inherited from class org.apache.commons.configuration.beanutils.DefaultBeanFactory

createBean, createBeanInstance, getDefaultBeanClass

Methods inherited from class org.apache.commons.configuration.DefaultConfigurationBuilder.ConfigurationProvider

fetchConfigurationClass, getConfigurationClass, getConfigurationClassName, loadClass, setConfigurationClass, setConfigurationClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

FileConfigurationProvider

public FileConfigurationProvider()

Creates a new instance of FileConfigurationProvider.

FileConfigurationProvider

public FileConfigurationProvider(java.lang.Class<?> configClass)

Creates a new instance of FileConfigurationProvider and sets the configuration class.

Parameters:

configClass - the class for the configurations to be created

FileConfigurationProvider

public FileConfigurationProvider(java.lang.String configClassName)

Creates a new instance of FileConfigurationProvider and sets the configuration class name.

Parameters:

configClassName - the name of the configuration to be created

Since:

1.4

Method Detail

getConfiguration

public AbstractConfiguration getConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)
                                       throws java.lang.Exception

Creates the configuration. After that load() will be called. If this configuration is marked as optional, exceptions will be ignored.

Overrides:

getConfiguration in class DefaultConfigurationBuilder.ConfigurationProvider

Parameters:

decl - the declaration

Returns:

the new configuration

Throws:

java.lang.Exception - if an error occurs

getEmptyConfiguration

public AbstractConfiguration getEmptyConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)
                                            throws java.lang.Exception

Returns an uninitialized file configuration. This method will be called for optional configurations when the getConfiguration() method caused an error and the forceCreate attribute is set. It will create the configuration of the represented type, but the load() method won't be called. This way non-existing configuration files can be handled gracefully: If loading a the file fails, an empty configuration will be created that is already configured with the correct file name.

Overrides:

getEmptyConfiguration in class DefaultConfigurationBuilder.ConfigurationProvider

Parameters:

decl - the bean declaration with initialization parameters for the configuration

Returns:

the new configuration object

Throws:

java.lang.Exception - if an error occurs

Since:

1.4

initBeanInstance

protected void initBeanInstance(java.lang.Object bean,
                                BeanDeclaration data)
                         throws java.lang.Exception

Initializes the bean instance. Ensures that the file configuration's base path will be initialized with the base path of the factory so that relative path names can be correctly resolved.

Overrides:

initBeanInstance in class DefaultBeanFactory

Parameters:

bean - the bean to be initialized

data - the declaration

Throws:

java.lang.Exception - if an error occurs