commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1592021 - in /commons/proper/configuration/trunk/src/site/xdoc/userguide: overview.xml user_guide.xml
Date Fri, 02 May 2014 19:57:48 GMT
Author: oheger
Date: Fri May  2 19:57:48 2014
New Revision: 1592021

Reworked section about threading issues.

Added information about immutable configurations. Referred to the dedicated
section in the user guide.


Modified: commons/proper/configuration/trunk/src/site/xdoc/userguide/overview.xml
--- commons/proper/configuration/trunk/src/site/xdoc/userguide/overview.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/userguide/overview.xml Fri May  2 19:57:48
@@ -200,13 +200,21 @@
       <subsection name="Threading issues">
-        The most concrete implementations of the <code>Configuration</code>
-        interface that are shipped with this library are not thread-safe.
-        They can be accessed concurrently 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.
+        When accessing configurations from multiple threads - be it in a
+        read-only or in a manipulating manner - the question arises whether
+        <code>Configuration</code> implementations are thread-safe. When
+        using immutable configurations as described in the previous section
+        you are typically on the safe side because immutable objects can
+        safely be shared between multiple threads. However, the
+        <code>ImmutableConfiguration</code> objects created by
+        <code>ConfigurationUtils</code> are just wrappers around a mutable
+        <code>Configuration</code> object. So if code holds a reference to the
+        underlying <code>Configuration</code>, it can still be changed.
+      </p>
+      <p>
+        Because concurrency is a complex topic this user's guide contains a
+        dedicated section to this topic: <a href="howto_concurrency.html">
+        Configurations and Concurrent Access</a>.

Modified: commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml
--- commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/userguide/user_guide.xml Fri May  2 19:57:48
@@ -41,8 +41,8 @@
       <li><a href="overview.html#Using_Configuration">Using Configuration</a></li>
         <li><a href="overview.html#Configuration_Sources">Configuration Sources</a></li>
-        <li><a href="overview.html#Mixing_Configuration_Sources">Mixing Configuration
         <li><a href="overview.html#The_Configuration_interface">The Configuration
+        <li><a href="overview.html#Immutable_Configurations">Immutable Configurations</a></li>
         <li><a href="overview.html#Threading_issues">Threading issues</a></li>
       <li><a href="howto_basicfeatures.html#Basic_features_and_AbstractConfiguration">Basic
features and AbstractConfiguration</a></li>

View raw message