Class DefaultConfigurationBuilder.ConfigurationDeclaration

java.lang.Object
org.apache.commons.configuration.beanutils.XMLBeanDeclaration
org.apache.commons.configuration.DefaultConfigurationBuilder.ConfigurationDeclaration
All Implemented Interfaces:
BeanDeclaration
Enclosing class:
DefaultConfigurationBuilder
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.

Since:
1.3
Version:
$Id: DefaultConfigurationBuilder.java 1366930 2012-07-29 20:05:36Z oheger $
Author:
Commons Configuration team

  • Constructor Details

  • Method Details

    • getConfigurationBuilder

      public DefaultConfigurationBuilder getConfigurationBuilder()
      Returns the associated configuration builder.
      Returns:
      the configuration builder

    • getAt

      public String getAt()
      Returns the value of the at attribute.
      Returns:
      the value of the at attribute (can be null)

    • isOptional

      public boolean isOptional()
      Returns a flag whether this is an optional configuration.
      Returns:
      a flag if this declaration points to an optional configuration

    • 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

    • 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.
      Specified by:
      getBeanFactoryName in interface BeanDeclaration
      Overrides:
      getBeanFactoryName in class XMLBeanDeclaration
      Returns:
      the name of the bean factory

    • getBeanClassName

      public String getBeanClassName()
      Returns the bean's class name. This implementation will always return null.
      Specified by:
      getBeanClassName in interface BeanDeclaration
      Overrides:
      getBeanClassName in class XMLBeanDeclaration
      Returns:
      the name of the bean's class

    • isReservedNode

      protected boolean isReservedNode(ConfigurationNode nd)
      Checks whether the given node is reserved. This method will take further reserved attributes into account
      Overrides:
      isReservedNode in class XMLBeanDeclaration
      Parameters:
      nd - the node
      Returns:
      a flag whether this node is reserved

    • 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.
      Overrides:
      interpolate in class XMLBeanDeclaration
      Parameters:
      value - the value to be interpolated
      Returns:
      the interpolated value