Class CombinedConfigurationBuilderProvider

  • All Implemented Interfaces:
    ConfigurationBuilderProvider

    public class CombinedConfigurationBuilderProvider
    extends BaseConfigurationBuilderProvider

    A specialized ConfigurationBuilderProvider implementation which deals with combined configuration builders.

    This class is used to support <configuration> elements in configuration definition files. The provider creates another CombinedConfigurationBuilder which inherits some of the properties from its parent builder.

    Since:
    2.0
    • Field Detail

      • BUILDER_CLASS

        private static final java.lang.String BUILDER_CLASS
        Constant for the name of the supported builder class.
        See Also:
        Constant Field Values
      • RELOADING_BUILDER_CLASS

        private static final java.lang.String RELOADING_BUILDER_CLASS
        Constant for the name of the supported reloading builder class.
        See Also:
        Constant Field Values
      • CONFIGURATION_CLASS

        private static final java.lang.String CONFIGURATION_CLASS
        Constant for the name of the supported configuration class.
        See Also:
        Constant Field Values
      • COMBINED_PARAMS

        private static final java.lang.String COMBINED_PARAMS
        Constant for the combined configuration builder parameters class.
        See Also:
        Constant Field Values
      • FILE_PARAMS

        private static final java.lang.String FILE_PARAMS
        Constant for the name of the file-based builder parameters class.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CombinedConfigurationBuilderProvider

        public CombinedConfigurationBuilderProvider()
        Creates a new instance of CombinedConfigurationBuilderProvider.
    • Method Detail

      • setUpBasicParameters

        private static void setUpBasicParameters​(CombinedConfiguration config,
                                                 BasicBuilderParameters params)
        Populates the specified parameters object with properties from the given configuration. This method is used to set default values for basic properties based on the result configuration of the parent builder.
        Parameters:
        config - the configuration whose properties are to be copied
        params - the target parameters object
      • createBuilder

        protected BasicConfigurationBuilder<? extends Configuration> createBuilder​(ConfigurationDeclaration decl,
                                                                                   java.util.Collection<BuilderParameters> params)
                                                                            throws java.lang.Exception
        Creates a new, uninitialized instance of the builder class managed by this provider. This implementation determines the builder class to be used by delegating to determineBuilderClass(). It then calls the constructor expecting the configuration class, the map with properties, and theallowFailOnInit flag. This implementation creates the result builder object directly, not using reflection. (The reflection-based approach of the base class does not work here because a combined configuration builder has constructors with a different signature.) It also performs some additional initializations.
        Overrides:
        createBuilder in class BaseConfigurationBuilderProvider
        Parameters:
        decl - the current ConfigurationDeclaration
        params - initialization parameters for the new builder object
        Returns:
        the newly created builder instance
        Throws:
        java.lang.Exception - if an error occurs
      • initializeParameterObjects

        protected void initializeParameterObjects​(ConfigurationDeclaration decl,
                                                  java.util.Collection<BuilderParameters> params)
                                           throws java.lang.Exception
        Initializes the parameter objects with data stored in the current bean declaration. This method is called before the newly created builder instance is configured with the parameter objects. It maps attributes of the bean declaration to properties of parameter objects. In addition, it invokes the parent CombinedConfigurationBuilder so that the parameters object can inherit properties already defined for this builder. This implementation pre-fills basic parameters from the basic properties of the parent builder's result configuration.
        Overrides:
        initializeParameterObjects in class BaseConfigurationBuilderProvider
        Parameters:
        decl - the current ConfigurationDeclaration
        params - the collection with (uninitialized) parameter objects
        Throws:
        java.lang.Exception - if an error occurs