org.apache.commons.configuration

Class DefaultConfigurationBuilder.ConfigurationDeclaration

public static class DefaultConfigurationBuilder.ConfigurationDeclaration extends XMLBeanDeclaration

A specialized BeanDeclaration implementation that represents the declaration of a configuration source.

Instances of this class are able to extract all information about a configuration source from the configuration definition file. The declaration of a configuration source is very similar to a bean declaration processed by XMLBeanDeclaration. There are very few differences, e.g. some reserved attributes like optional and at and the fact that a bean factory is never needed.

Field Summary
DefaultConfigurationBuilder	configurationBuilder Stores a reference to the associated configuration builder.

Constructor Summary
	ConfigurationDeclaration(DefaultConfigurationBuilder builder, HierarchicalConfiguration config) Creates a new instance of `ConfigurationDeclaration` and initializes it.

Method Summary
String	getAt() Returns the value of the `at` attribute.
String	getBeanClassName() Returns the bean's class name.
String	getBeanFactoryName() Returns the name of the bean factory.
DefaultConfigurationBuilder	getConfigurationBuilder() Returns the associated configuration builder.
protected Object	interpolate(Object value) Performs interpolation.
boolean	isForceCreate() Returns a flag whether this configuration should always be created and added to the resulting combined configuration.
boolean	isOptional() Returns a flag whether this is an optional configuration.
protected boolean	isReservedNode(ConfigurationNode nd) Checks whether the given node is reserved.

Field Detail

configurationBuilder

private DefaultConfigurationBuilder configurationBuilder

Stores a reference to the associated configuration builder.

Constructor Detail

ConfigurationDeclaration

public ConfigurationDeclaration(DefaultConfigurationBuilder builder, HierarchicalConfiguration config)

Creates a new instance of ConfigurationDeclaration and initializes it.

Parameters: builder the associated configuration builder config the configuration this declaration is based onto

Method Detail

getAt

public String getAt()

Returns the value of the at attribute.

Returns: the value of the at attribute (can be null)

getBeanClassName

public String getBeanClassName()

Returns the bean's class name. This implementation will always return null.

Returns: the name of the bean's class

getBeanFactoryName

public String getBeanFactoryName()

Returns the name of the bean factory. For configuration source declarations always a reserved factory is used. This factory's name is returned by this implementation.

Returns: the name of the bean factory

getConfigurationBuilder

public DefaultConfigurationBuilder getConfigurationBuilder()

Returns the associated configuration builder.

Returns: the configuration builder

interpolate

protected Object interpolate(Object value)

Performs interpolation. This implementation will delegate interpolation to the configuration builder, which takes care that the currently constructed configuration is taken into account, too.

Parameters: value the value to be interpolated

Returns: the interpolated value

isForceCreate

public boolean isForceCreate()

Returns a flag whether this configuration should always be created and added to the resulting combined configuration. This flag is evaluated only for optional configurations whose normal creation has caused an error. If for such a configuration the forceCreate attribute is set and the corresponding configuration provider supports this mode, an empty configuration will be created and added to the resulting combined configuration.

Returns: the value of the forceCreate attribute

Since: 1.4

isOptional

public boolean isOptional()

Returns a flag whether this is an optional configuration.

Returns: a flag if this declaration points to an optional configuration

isReservedNode

protected boolean isReservedNode(ConfigurationNode nd)

Checks whether the given node is reserved. This method will take further reserved attributes into account

Parameters: nd the node

Returns: a flag whether this node is reserved