org.apache.commons.configuration
public static class DefaultConfigurationBuilder.ConfigurationProvider extends DefaultBeanFactory
A base class for creating and initializing configuration sources.
Concrete sub classes of this base class are responsible for creating
specific Configuration
objects for the tags in the
configuration definition file. The configuration factory will parse the
definition file and try to find a matching
ConfigurationProvider
for each encountered tag. This
provider is then asked to create a corresponding
Configuration
object. It is up to a concrete
implementation how this object is created and initialized.
Note that at the moment only configuration classes derived from
AbstractConfiguration
are supported.
Field Summary | |
---|---|
Class | configurationClass Stores the class of the configuration to be created. |
String | configurationClassName Stores the name of the configuration class to be created. |
Constructor Summary | |
---|---|
ConfigurationProvider()
Creates a new uninitialized instance of
ConfigurationProvider . | |
ConfigurationProvider(Class configClass)
Creates a new instance of ConfigurationProvider and
sets the class of the configuration created by this provider.
| |
ConfigurationProvider(String configClassName)
Creates a new instance of ConfigurationProvider and
sets the name of the class of the configuration created by this
provider.
|
Method Summary | |
---|---|
protected Class | fetchConfigurationClass()
Returns the configuration class supported by this provider. |
AbstractConfiguration | getConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)
Returns the configuration. |
Class | getConfigurationClass()
Returns the class of the configuration returned by this provider.
|
String | getConfigurationClassName()
Returns the name of the configuration class returned by this
provider.
|
AbstractConfiguration | getEmptyConfiguration(DefaultConfigurationBuilder.ConfigurationDeclaration decl)
Returns an uninitialized configuration of the represented type. |
protected Class | loadClass(String className)
Loads the class with the specified name dynamically. |
void | setConfigurationClass(Class configurationClass)
Sets the class of the configuration returned by this provider.
|
void | setConfigurationClassName(String configurationClassName)
Sets the name of the configuration class returned by this provider.
|
ConfigurationProvider
.ConfigurationProvider
and
sets the class of the configuration created by this provider.
Parameters: configClass the configuration class
ConfigurationProvider
and
sets the name of the class of the configuration created by this
provider.
Parameters: configClassName the name of the configuration class
Since: 1.4
Returns: the class of the configuration to be created
Since: 1.4
createBean()
method to create a new instance of the
configuration class.
Parameters: decl the bean declaration with initialization parameters for the configuration
Returns: the new configuration object
Throws: Exception if an error occurs
Returns: the class of the provided configuration
Returns: the configuration class name
Since: 1.4
getConfiguration()
method caused an error and the
forceCreate
attribute is set. A concrete sub class can
here try to create an uninitialized, empty configuration, which may
be possible if the error was created during initialization. This base
implementation just returns null.
Parameters: decl the bean declaration with initialization parameters for the configuration
Returns: the new configuration object
Throws: Exception if an error occurs
Since: 1.4
Parameters: className the name of the class to be loaded
Returns: the class object
Throws: ClassNotFoundException if class loading fails
Since: 1.4
Parameters: configurationClass the configuration class
Parameters: configurationClassName the name of the configuration class
Since: 1.4