Author: oheger
Date: Fri Mar 30 02:33:17 2007
New Revision: 524006
URL: http://svn.apache.org/viewvc?view=rev&rev=524006
Log:
CONFIGURATION-259: Added hints to the documentation of ConfigurationFactory
that refer to DefaultConfigurationBuilder and recommend that this class should
be used
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/ConfigurationFactory.java
jakarta/commons/proper/configuration/trunk/xdocs/howto_configurationfactory.xml
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/ConfigurationFactory.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/ConfigurationFactory.java?view=diff&rev=524006&r1=524005&r2=524006
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/ConfigurationFactory.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/ConfigurationFactory.java
Fri Mar 30 02:33:17 2007
@@ -43,11 +43,20 @@
import org.xml.sax.SAXException;
/**
+ * <p>
* Factory class to create a CompositeConfiguration from a .xml file using
* Digester. By default it can handle the Configurations from commons-
* configuration. If you need to add your own, then you can pass in your own
* digester rules to use. It is also namespace aware, by providing a
* digesterRuleNamespaceURI.
+ * </p>
+ * <p>
+ * <em>Note:</em> Almost all of the features provided by this class and many
+ * more are also available for the <code>[EMAIL PROTECTED]
DefaultConfigurationBuilder}</code>
+ * class. <code>DefaultConfigurationBuilder</code> also has a more robust
+ * merge algorithm for constructing combined configurations. So it is
+ * recommended to use this class instead of <code>ConfigurationFactory</code>.
+ * </p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Eric Pugh</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
Modified:
jakarta/commons/proper/configuration/trunk/xdocs/howto_configurationfactory.xml
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/xdocs/howto_configurationfactory.xml?view=diff&rev=524006&r1=524005&r2=524006
==============================================================================
---
jakarta/commons/proper/configuration/trunk/xdocs/howto_configurationfactory.xml
(original)
+++
jakarta/commons/proper/configuration/trunk/xdocs/howto_configurationfactory.xml
Fri Mar 30 02:33:17 2007
@@ -30,7 +30,18 @@
<code>ConfigurationFactory</code> object is setup that provides
access
to a collection of different configuration sources.
</p>
-
+ <p>
+ <em>Note:</em> In earlier versions of <em>Commons Configuration</em>
+ the <code>ConfigurationFactory</code> class was the only means for
+ combining multiple configuration sources to a single configuration.
+ With the newer <code>DefaultConfigurationBuilder</code> class there
+ is now an alternative available that provides more features. So it
+ is recommended to use <code>DefaultConfigurationBuilder</code>
instead
+ of <code>ConfigurationFactory</code> whereever possible. More details
+ about <code>DefaultConfigurationBuilder</code> can be found
+ <a href="howto_configurationbuilder.html">here</a>.
+ </p>
+
<subsection name="The configuration definition file">
<p>
When a single configuration file (e.g. a
properties file) is the only
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
