Author: oheger
Date: Sun Jun 8 18:24:48 2014
New Revision: 1601239
URL: http://svn.apache.org/r1601239
Log:
Added a subsection with builder parameters for XML configurations.
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_xml.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_xml.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_xml.xml?rev=1601239&r1=1601238&r2=1601239&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_xml.xml
(original)
+++ commons/proper/configuration/trunk/src/site/xdoc/userguide/howto_xml.xml
Sun Jun 8 18:24:48 2014
@@ -250,6 +250,34 @@ FileBasedConfigurationBuilder<XMLConfigu
XMLConfiguration config = builder.getConfiguration();
]]></source>
</subsection>
+
+ <subsection name="Builder Configuration Related to XML Configurations">
+ <p>
+ XML configurations are created in the typical way: via configuration
+ builders. The initialization parameters supported for them include all
+ the settings available for hierarchical configurations and file-based
+ configurations. In addition, the
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/XMLBuilderProperties.html">
+ XMLBuilderProperties</a></code> interface defines settings specific to
+ XML configurations. This includes
+ <ul>
+ <li>a custom <code>DocumentBuilder</code></li>
+ <li>a custom <code>EntityResolver</code></li>
+ <li>flags whether the XML document is to be validated and how this
+ validation is to be performed</li>
+ <li>the public and the system ID of the document when it is
written</li>
+ </ul>
+ </p>
+ <p>
+ A parameters object for an XML configuration can be obtained using
+ the <code>xml()</code> method of a
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/fluent/Parameter.html">
+ Parameters</a></code> instance. It returns an object implementing the
+ <code><a
href="../apidocs/org/apache/commons/configuration/builder/fluent/XMLBuilderParameters.html">
+ XMLBuilderParameters</a></code> interface which defines set
+ methods for all the available properties.
+ </p>
+ </subsection>
</section>
</body>
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=1601239&r1=1601238&r2=1601239&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 8 18:24:48 2014
@@ -104,6 +104,7 @@
<li><a href="howto_xml.html#Default_Entity_Resolution">Default Entity
Resolution</a></li>
<li><a href="howto_xml.html#Enhanced_Entity_Resolution">Enhanced
Entity Resolution</a></li>
<li><a
href="howto_xml.html#Extending_Validation_and_Entity_Resolution">Extending
Validation and Entity Resolution</a></li>
+ <li><a
href="howto_xml.html#Builder_Configuration_Related_to_XML_Configurations">Builder
Configuration Related to XML Configurations</a></li>
</ul>
<li><a
href="howto_reloading.html#Composite_Configuration_Details">Automatic Reloading
of Configuration Sources</a></li>
<ul>
