You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2013/03/24 15:13:48 UTC
svn commit: r1460381 -
/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Author: ggregory
Date: Sun Mar 24 14:13:48 2013
New Revision: 1460381
URL: http://svn.apache.org/r1460381
Log:
Javadoc toBuilder().
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Modified: commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
URL: http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java?rev=1460381&r1=1460380&r2=1460381&view=diff
==============================================================================
--- commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java (original)
+++ commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java Sun Mar 24 14:13:48 2013
@@ -33,9 +33,14 @@ import java.util.Arrays;
/**
* The format specification of a CSV file.
- *
+ * <p>
* This class is immutable.
- *
+ * </p>
+ * <p>
+ * You can extend a format through a builder. For example, to extend the Excel format with columns header, you write:
+ * </p>
+ * <pre>CSVFormat.EXCEL.toBuilder().withHeader("Col1", "Col2", "Col3").build();</pre>
+ *
* @version $Id$
*/
public class CSVFormat implements Serializable {