svn commit: r1483060 - /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java

[oh...@apache.org]

Author: oheger
Date: Wed May 15 20:06:06 2013
New Revision: 1483060

URL: http://svn.apache.org/r1483060
Log:
Updated Javadocs related to thread-safety.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java?rev=1483060&r1=1483059&r2=1483060&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/INIConfiguration.java Wed May 15 20:06:06 2013
@@ -188,9 +188,16 @@ import org.apache.commons.configuration.
  * {@code getSection()} method can be used.
  * </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.
+ * Like other {@code Configuration} implementations, this class uses a
+ * {@code Synchronizer} object to control concurrent access. By choosing a
+ * suitable implementation of the {@code Synchronizer} interface, an instance
+ * can be made thread-safe or not. Note that access to most of the properties
+ * typically set through a builder is not protected by the {@code Synchronizer}.
+ * The intended usage is that these properties are set once at construction
+ * time through the builder and after that remain constant. If you wish to
+ * change such properties during life time of an instance, you have to use
+ * the {@code lock()} and {@code unlock()} methods manually to ensure that
+ * other threads see your changes.
  * </p>
  *
  * @author <a