Author: oheger
Date: Sun Jun 17 12:34:03 2007
New Revision: 548098
URL: http://svn.apache.org/viewvc?view=rev&rev=548098
Log:
Javadoc only: added notes about thread-safety to the most important
Configuration implementations
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalConfiguration.java
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/INIConfiguration.java
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/MapConfiguration.java
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertiesConfiguration.java
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLConfiguration.java
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLPropertiesConfiguration.java
jakarta/commons/proper/configuration/trunk/xdocs/overview.xml
jakarta/commons/proper/configuration/trunk/xdocs/userguide/user_guide.xml
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -118,6 +118,9 @@
* that was created from this configuration has been changed. The value
property
* of the event object contains the original event object as it was sent by the
* subnode configuration.</dd></dl></p>
+ * <p><em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.</p>
*
* @author Oliver Heger
* @version $Id$
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/INIConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/INIConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/INIConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/INIConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -157,6 +157,11 @@
* The set of sections in this configuration can be retrieved using the
* <code>getSections</code> method.
* </p>
+ * <p>
+ * <em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.
+ * </p>
*
* @author Trevor Miller
* @version $Id$
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/MapConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/MapConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/MapConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/MapConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -23,7 +23,10 @@
import java.util.Map;
/**
- * A Map based Configuration.
+ * <p>A Map based Configuration.</p>
+ * <p><em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.</p>
*
* @author Emmanuel Bourg
* @version $Revision$, $Date$
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertiesConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertiesConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertiesConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertiesConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -140,6 +140,9 @@
* method can be used to obtain this layout object. With
<code>setLayout()</code>
* a new layout object can be set. This should be done before a properties file
* was loaded.
+ * <p><em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.
*
* @see java.util.Properties#load
*
@@ -155,7 +158,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Martin Poeschl</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Eric Pugh</a>
- * @author <a href="mailto:[EMAIL PROTECTED]">Oliver Heger</a>
+ * @author Oliver Heger
* @author <a href="mailto:[EMAIL PROTECTED]">Emmanuel Bourg</a>
* @version $Id$
*/
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -127,6 +127,10 @@
* features can be found in the documentation of
* <code>[EMAIL PROTECTED] AbstractFileConfiguration}</code>.</p>
*
+ * <p><em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.</p>
+ *
* @since commons-configuration 1.0
*
* @author Jörg Schaible
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLPropertiesConfiguration.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLPropertiesConfiguration.java?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLPropertiesConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/XMLPropertiesConfiguration.java
Sun Jun 17 12:34:03 2007
@@ -57,6 +57,10 @@
* <code>PropertiesConfiguration</code>,
<code>XMLPropertiesConfiguration</code>
* does not support includes.
*
+ * <em>Note:</em>Configuration objects of this type can be read concurrently
+ * by multiple threads. However if one of these threads modifies the object,
+ * synchronization has to be performed manually.
+ *
* @author Emmanuel Bourg
* @author Alistair Young
* @version $Revision$, $Date$
Modified: jakarta/commons/proper/configuration/trunk/xdocs/overview.xml
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/xdocs/overview.xml?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
--- jakarta/commons/proper/configuration/trunk/xdocs/overview.xml (original)
+++ jakarta/commons/proper/configuration/trunk/xdocs/overview.xml Sun Jun 17
12:34:03 2007
@@ -195,6 +195,18 @@
</dl>
</p>
</subsection>
+
+ <subsection name="Threading issues">
+ <p>
+ The most concrete implementations of the <code>Configuration</code>
+ interface that are shipped with this library are thread-safe as long as
+ they are accessed in a read-only manner. However if one thread
+ modifies a configuration object, manual synchronization has to be
+ performed to ensure correctness of data. Notes about the thread
+ safety of conrete implementation classes can be found in the Javadocs
+ for these classes.
+ </p>
+ </subsection>
</section>
</body>
Modified:
jakarta/commons/proper/configuration/trunk/xdocs/userguide/user_guide.xml
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/xdocs/userguide/user_guide.xml?view=diff&rev=548098&r1=548097&r2=548098
==============================================================================
--- jakarta/commons/proper/configuration/trunk/xdocs/userguide/user_guide.xml
(original)
+++ jakarta/commons/proper/configuration/trunk/xdocs/userguide/user_guide.xml
Sun Jun 17 12:34:03 2007
@@ -50,6 +50,7 @@
<li><a href="overview.html#Configuration_Sources">Configuration
Sources</a></li>
<li><a href="overview.html#Mixing_Configuration_Sources">Mixing
Configuration Sources</a></li>
<li><a href="overview.html#The_Configuration_interface">The
Configuration interface</a></li>
+ <li><a href="overview.html#Threading_issues">Threading issues</a></li>
</ul>
<li><a
href="howto_basicfeatures.html#Basic_features_and_AbstractConfiguration">Basic
features and AbstractConfiguration</a></li>
<ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
