diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index f729dd69..e8e642ed 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -161,28 +161,30 @@ public final class CSVFormat implements Serializable {
/**
* Standard comma separated format, as for {@link #RFC4180} but allowing empty lines.
- *
RFC 4180:
+ *
+ * Settings are:
*
- * - withDelimiter(',')
- * - withQuoteChar('"')
- * - withRecordSeparator(CRLF)
- *
- * Additional:
- *
- * - withIgnoreEmptyLines(true)
+ * - withDelimiter(',')
+ * - withQuoteChar('"')
+ * - withRecordSeparator("\r\n")
+ * - withIgnoreEmptyLines(true)
*
+ *
*/
public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null,
false, true, CRLF, null, null, false, false);
/**
* Comma separated format as defined by RFC 4180.
- * RFC 4180:
+ *
+ * Settings are:
*
- * - withDelimiter(',')
- * - withQuoteChar('"')
- * - withRecordSeparator(CRLF)
+ * - withDelimiter(',')
+ * - withQuoteChar('"')
+ * - withRecordSeparator("\r\n")
+ * - withIgnoreEmptyLines(false)
*
+ *
*/
public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);
@@ -195,32 +197,59 @@ public final class CSVFormat implements Serializable {
*
*
*
- * CSVFormat fmt = CSVFormat.newBuilder(EXCEL).withDelimiter(';');
+ * CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');
*
*
*
* Settings are:
- *
*
- * - withDelimiter(',')
- * - withQuoteChar('"')
- * - withRecordSeparator(CRLF)
+ * - withDelimiter(',')
+ * - withQuoteChar('"')
+ * - withRecordSeparator("\r\n")
+ * - withIgnoreEmptyLines(false)
*
- * Note: this is currently the same as RFC4180
+ *
+ *
+ * Note: this is currently the same as {@link #RFC4180}.
+ *
*/
public static final CSVFormat EXCEL = DEFAULT.withIgnoreEmptyLines(false);
- /** Tab-delimited format, with quote; leading and trailing spaces ignored. */
+ /**
+ * Tab-delimited format.
+ *
+ * Settings are:
+ *
+ * - withDelimiter('\t')
+ * - withQuoteChar('"')
+ * - withRecordSeparator("\r\n")
+ * - withIgnoreSurroundingSpaces(true)
+ *
+ *
+ */
public static final CSVFormat TDF =
DEFAULT
.withDelimiter(TAB)
.withIgnoreSurroundingSpaces(true);
/**
- * Default MySQL format used by the SELECT INTO OUTFILE and LOAD DATA INFILE operations. This is
- * a tab-delimited format with a LF character as the line separator. Values are not quoted and special characters
- * are escaped with '\'.
+ * Default MySQL format used by the SELECT INTO OUTFILE and LOAD DATA INFILE operations.
*
+ *
+ * This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special characters
+ * are escaped with '\'.
+ *
+ *
+ *
+ * Settings are:
+ *
+ * - withDelimiter('\t')
+ * - withQuoteChar(null)
+ * - withRecordSeparator('\n')
+ * - withIgnoreEmptyLines(false)
+ * - withEscape('\\')
+ *
+ *
* @see
* http://dev.mysql.com/doc/refman/5.1/en/load-data.html
*/
@@ -259,10 +288,19 @@ public final class CSVFormat implements Serializable {
/**
* Creates a new CSV format with the specified delimiter.
*
+ * Use this method if you want to create a CSVFormat from scratch. All fields but the delimiter will be
+ * initialized with null/false.
+ *
* @param delimiter
* the char used for value separation, must not be a line break character
* @return a new CSV format.
* @throws IllegalArgumentException if the delimiter is a line break character
+ *
+ * @see #DEFAULT
+ * @see #RFC4180
+ * @see #MYSQL
+ * @see #EXCEL
+ * @see #TDF
*/
public static CSVFormat newFormat(final char delimiter) {
return new CSVFormat(delimiter, null, null, null, null, false, false, null, null, null, false, false);