Standardise on recordSeparator; fix incorrect Javadoc comments

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1468825 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastian Bazley 2013-04-17 10:28:33 +00:00
parent f16818b3ba
commit 939a8a04eb
1 changed files with 8 additions and 8 deletions

View File

@ -98,15 +98,15 @@ public class CSVFormat implements Serializable {
* @param nullToString TODO * @param nullToString TODO
* @param header * @param header
* the header * the header
* @param lineSeparator * @param recordSeparator
* the line separator to use for output * the record separator to use for output
* @throws IllegalArgumentException if the delimiter is a line break character * @throws IllegalArgumentException if the delimiter is a line break character
*/ */
// package protected for use by test code // package protected for use by test code
CSVFormatBuilder(final char delimiter, final Character quoteChar, CSVFormatBuilder(final char delimiter, final Character quoteChar,
final Quote quotePolicy, final Character commentStart, final Quote quotePolicy, final Character commentStart,
final Character escape, final boolean ignoreSurroundingSpaces, final Character escape, final boolean ignoreSurroundingSpaces,
final boolean ignoreEmptyLines, final String lineSeparator, final boolean ignoreEmptyLines, final String recordSeparator,
String nullToString, final String[] header) { String nullToString, final String[] header) {
if (isLineBreak(delimiter)) { if (isLineBreak(delimiter)) {
throw new IllegalArgumentException("The delimiter cannot be a line break"); throw new IllegalArgumentException("The delimiter cannot be a line break");
@ -118,7 +118,7 @@ public class CSVFormat implements Serializable {
this.escape = escape; this.escape = escape;
this.ignoreSurroundingSpaces = ignoreSurroundingSpaces; this.ignoreSurroundingSpaces = ignoreSurroundingSpaces;
this.ignoreEmptyLines = ignoreEmptyLines; this.ignoreEmptyLines = ignoreEmptyLines;
this.recordSeparator = lineSeparator; this.recordSeparator = recordSeparator;
this.nullToString = nullToString; this.nullToString = nullToString;
this.header = header; this.header = header;
} }
@ -431,7 +431,7 @@ public class CSVFormat implements Serializable {
* <li>withDelimiter(',')</li> * <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li> * <li>withQuoteChar('"')</li>
* <li>withEmptyLinesIgnored(true)</li> * <li>withEmptyLinesIgnored(true)</li>
* <li>withLineSeparator(CRLF)</li> * <li>withRecordSeparator(CRLF)</li>
* </ul> * </ul>
* *
* Shortcut for {@code CSVFormat.newBuilder(CSVFormat.DEFAULT)} * Shortcut for {@code CSVFormat.newBuilder(CSVFormat.DEFAULT)}
@ -462,7 +462,7 @@ public class CSVFormat implements Serializable {
* <ul> * <ul>
* <li>withDelimiter(',')</li> * <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li> * <li>withQuoteChar('"')</li>
* <li>withLineSeparator(CRLF)</li> * <li>withRecordSeparator(CRLF)</li>
* </ul> * </ul>
*/ */
public static final CSVFormat RFC4180 = public static final CSVFormat RFC4180 =
@ -476,7 +476,7 @@ public class CSVFormat implements Serializable {
* <ul> * <ul>
* <li>withDelimiter(',')</li> * <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li> * <li>withQuoteChar('"')</li>
* <li>withLineSeparator(CRLF)</li> * <li>withRecordSeparator(CRLF)</li>
* </ul> * </ul>
* <h3>Additional:</h3> * <h3>Additional:</h3>
* <ul> * <ul>
@ -500,7 +500,7 @@ public class CSVFormat implements Serializable {
* <ul> * <ul>
* <li>withDelimiter(',')</li> * <li>withDelimiter(',')</li>
* <li>withQuoteChar('"')</li> * <li>withQuoteChar('"')</li>
* <li>withLineSeparator(CRLF)</li> * <li>withRecordSeparator(CRLF)</li>
* </ul> * </ul>
* Note: this is currently the same as RFC4180 * Note: this is currently the same as RFC4180
*/ */