Author: oheger
Date: Sun Jun 29 19:42:41 2014
New Revision: 1606584
URL: http://svn.apache.org/r1606584
Log:
Added a section about the initialization parameters of multi-file configs.
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_multitenant.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_multitenant.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_multitenant.xml?rev=1606584&r1=1606583&r2=1606584&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_multitenant.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_multitenant.xml
Sun Jun 29 19:42:41 2014
@@ -169,6 +169,52 @@
accessed instead of when the configuration file is processed to
behave as desired.
</p>
</subsection>
+ <subsection name="Builder Configuration Related to Multi-file
Configurations">
+ <p>
+ When setting up a
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/combined/MultiFileConfigurationBuilder.html">
+ MultiFileConfigurationBuilder</a></code> a special object with
+ initialization parameters can be used as argument to the
+ <code>configure()</code> method. It is of type
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/fluent/MultiFileBuilderParameters.html">
+ MultiFileBuilderParameters</a></code> and can be obtained via the
+ <code>multiFile()</code> method of a
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/fluent/Parameter.html">
+ Parameters</a></code> object. The properties specific to this
+ configuration type are defined by the
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/MultiFileBuilderProperties.html">
+ MultiFileBuilderProperties</a></code> interface. They include
+ <ul>
+ <li>The pattern string for determining the name of the
+ configuration file to be loaded. This is of course the most
+ important setting as it tells the builder how to perform
interpolation
+ in order to resolve the correct configuration file.</li>
+ <li>A parameters object for the file-based configuration builder
+ used behind the scenes to load the configuration file. Here some
+ additional settings can be provided. For instance, if the
+ configuration files to be loaded are XML documents, validation
+ could be enabled via these parameters.</li>
+ </ul>
+ </p>
+ <p>
+ Below is a code fragment demonstrating the set up of a
+ <code>MultiFileConfigurationBuilder</code> which loads configuration
+ files of type XML:
+ </p>
+ <source><![CDATA[
+Parameters params = new Parameters();
+MultiFileConfigurationBuilder<XMLConfiguration> builder =
+ new MultiFileConfigurationBuilder(XMLConfiguration.class)
+ .configure(params.multiFile()
+ .setFilePattern("configuration_${sys:Id}.xml")
+ .setManagedBuilderParameters(params.xml()
+ .setValidating(true)
+ )
+ );
+
+XMLConfiguration config = builder.getConfiguration();
+]]></source>
+ </subsection>
<subsection name="PatternSubtreeConfigurationWrapper">
<p>
Applications are often composed of many components each of which
need their
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml?rev=1606584&r1=1606583&r2=1606584&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
(original)
+++ commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
Sun Jun 29 19:42:41 2014
@@ -152,6 +152,7 @@
<li><a
href="howto_multitenant.html#MultiFileConfigurationBuilder">MultiFileConfigurationBuilder</a></li>
<li><a
href="howto_multitenant.html#DynamicCombinedConfiguration">DynamicCombinedConfiguration</a></li>
<li><a href="howto_multitenant.html#Sample Configuration">Sample
Configuration</a></li>
+ <li><a
href="howto_configurationbuilder.html#Builder_Configuration_Related_to_Multi-file_Configurations">Builder
Configuration Related to Multi-file Configurations</a></li>
<li><a
href="howto_multitenant.html#PatternSubtreeConfigurationWrapper">PatternSubtreeConfigurationWrapper</a></li>
</ul>
<li><a href="howto_events.html#Configuration_Events">Configuration
Events</a></li>
