Author: niallp
Date: Thu Nov 15 20:26:16 2007
New Revision: 595544
URL: http://svn.apache.org/viewvc?rev=595544&view=rev
Log:
Javadoc changes only
Modified:
commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
Modified:
commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java?rev=595544&r1=595543&r2=595544&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
(original)
+++
commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
Thu Nov 15 20:26:16 2007
@@ -691,7 +691,7 @@
//-----------------------------------------------------------------------
/**
- * <p>Returns a <code>String</code> value for a CSV column escaping with
double quotes,
+ * <p>Returns a <code>String</code> value for a CSV column enclosed in
double quotes,
* if required.</p>
*
* <p>If the value contains a comma, newline or double quote, then the
@@ -700,11 +700,16 @@
*
* <p>Any double quote characters in the value are escaped with another
double quote.</p>
*
+ * <p>If the value does not contain a comma, newline or double quote, then
the
+ * String value is returned unchanged.</p>
+ * </p>
+ *
* see <a
href="http://en.wikipedia.org/wiki/Comma-separated_values";>Wikipedia</a> and
* <a href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>.
*
- * @param str the string to escape, may be null
- * @return a new String, escaped for CSV, <code>null</code> if null string
input
+ * @param str the input CSV column String, may be null
+ * @return the input String, enclosed in double quotes if the value
contains a comma,
+ * newline or double quote, <code>null</code> if null string input
* @since 2.4
*/
public static String escapeCsv(String str) {
@@ -725,7 +730,7 @@
}
/**
- * <p>Writes a <code>String</code> value for a CSV column escaping with
double quotes,
+ * <p>Writes a <code>String</code> value for a CSV column enclosed in
double quotes,
* if required.</p>
*
* <p>If the value contains a comma, newline or double quote, then the
@@ -734,13 +739,16 @@
*
* <p>Any double quote characters in the value are escaped with another
double quote.</p>
*
+ * <p>If the value does not contain a comma, newline or double quote, then
the
+ * String value is written unchanged (null values are ignored).</p>
+ * </p>
+ *
* see <a
href="http://en.wikipedia.org/wiki/Comma-separated_values";>Wikipedia</a> and
* <a href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>.
*
- * @param str the string to escape, may be null
- * @param out Writer to write escaped string into
- * in double quotes or only when the value contains double quotes, commas
or newline
- * characters.
+ * @param str the input CSV column String, may be null
+ * @param out Writer to write input string to, enclosed in double quotes
if it contains
+ * a comma, newline or double quote
* @throws IOException if error occurs on underlying Writer
* @since 2.4
*/
