svn commit: r1502853 - /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/PropertiesConfiguration.java

[oh...@apache.org]

Author: oheger
Date: Sat Jul 13 19:32:25 2013
New Revision: 1502853

URL: http://svn.apache.org/r1502853
Log:
Javadocs update related to list delimiter handling.

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

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/PropertiesConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/PropertiesConfiguration.java?rev=1502853&r1=1502852&r2=1502853&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/PropertiesConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/PropertiesConfiguration.java Sat Jul 13 19:32:25 2013
@@ -74,15 +74,18 @@ import org.apache.commons.lang3.text.tra
  *   is placed at the end of the line that continues below.
  *  </li>
  *  <li>
- *   <i>value</i> can contain <em>value delimiters</em> and will then be interpreted
- *   as a list of tokens. Default value delimiter is the comma ','. So the
+ *   The list delimiter facilities provided by {@link AbstractConfiguration}
+ *   are supported, too. If an appropriate {@link ListDelimiterHandler} is
+ *   set (for instance a {@link DefaultListDelimiterHandler} object configured
+ *   with a comma as delimiter character), <i>value</i> can contain <em>value
+ *   delimiters</em> and will then be interpreted as a list of tokens. So the
  *   following property definition
  * <pre>
  *  key = This property, has multiple, values
  * </pre>
- *   will result in a property with three values. You can change the value
- *   delimiter using the {@link AbstractConfiguration#setListDelimiter(char)}
- *   method. Setting the delimiter to 0 will disable value splitting completely.
+ *   will result in a property with three values. You can change the handling
+ *   of delimiters using the {@link AbstractConfiguration#setListDelimiterHandler(char)}
+ *   method. Per default, list splitting is disabled.
  *  </li>
  *  <li>
  *   Commas in each token are escaped placing a backslash right before