svn commit: r548098 - in /jakarta/commons/proper/configuration/trunk: src/java/org/apache/commons/configuration/ xdocs/ xdocs/userguide/

2007-06-17 Thread oheger 
Author: oheger
Date: Sun Jun 17 12:34:03 2007
New Revision: 548098

URL: http://svn.apache.org/viewvc?view=revrev=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=diffrev=548098r1=548097r2=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
+ * pemNote:/emConfiguration 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=diffrev=548098r1=548097r2=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
  * codegetSections/code method.
  * /p
+ * p
+ * emNote:/emConfiguration 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=diffrev=548098r1=548097r2=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.
+ * pA Map based Configuration./p
+ * pemNote:/emConfiguration 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=diffrev=548098r1=548097r2=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

Re: [configuration] svn commit: r548098 - in /jakarta/commons/proper/configuration/trunk: src/java/org/apache/commons/configuration/ xdocs/ xdocs/userguide/

2007-06-17 Thread Rahul Akolkar 

On 6/17/07, [EMAIL PROTECTED] [EMAIL PROTECTED] wrote:

Author: oheger
Date: Sun Jun 17 12:34:03 2007
New Revision: 548098

URL: http://svn.apache.org/viewvc?view=revrev=548098
Log:
Javadoc only: added notes about thread-safety to the most important 
Configuration implementations


snip/

+
+  subsection name=Threading issues
+  p
+The most concrete implementations of the codeConfiguration/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

snap/

I think the first sentence should simply state that most
implementations are not thread-safe (rather than the read-only bit
which I found unnecessary, perhaps confusing).

WDYT?

-Rahul

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Re: [configuration] svn commit: r548098 - in /jakarta/commons/proper/configuration/trunk: src/java/org/apache/commons/configuration/ xdocs/ xdocs/userguide/

2007-06-17 Thread Oliver Heger 

Rahul Akolkar wrote:

On 6/17/07, [EMAIL PROTECTED] [EMAIL PROTECTED] wrote:

Author: oheger
Date: Sun Jun 17 12:34:03 2007
New Revision: 548098

URL: http://svn.apache.org/viewvc?view=revrev=548098
Log:
Javadoc only: added notes about thread-safety to the most important 
Configuration implementations



snip/

+
+  subsection name=Threading issues
+  p
+The most concrete implementations of the 
codeConfiguration/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

snap/

I think the first sentence should simply state that most
implementations are not thread-safe (rather than the read-only bit
which I found unnecessary, perhaps confusing).

WDYT?

-Rahul


How about:
The most concrete implementations of the codeConfiguration/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.


Oliver

BTW: Thanks for the hint.

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Re: [configuration] svn commit: r548098 - in /jakarta/commons/proper/configuration/trunk: src/java/org/apache/commons/configuration/ xdocs/ xdocs/userguide/

2007-06-17 Thread Rahul Akolkar 

On 6/17/07, Oliver Heger [EMAIL PROTECTED] wrote:
snip/

How about:
The most concrete implementations of the codeConfiguration/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.


snap/

Yup, thanks!

-Rahul



Oliver

BTW: Thanks for the hint.



-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]