Skip to content

Commit 1ad1538

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent 88efa32 commit 1ad1538

File tree

1 file changed

+70
-72
lines changed

1 file changed

+70
-72
lines changed

‎src/main/java/org/apache/commons/csv/CSVFormat.java‎

Lines changed: 70 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -194,12 +194,12 @@ public static class Builder implements Supplier<CSVFormat> {
194194
* The {@link Builder} settings are:
195195
* </p>
196196
* <ul>
197-
* <li>{@code setDelimiter(',')}</li>
198-
* <li>{@code setQuote('"')}</li>
199-
* <li>{@code setRecordSeparator("\r\n")}</li>
200-
* <li>{@code setIgnoreEmptyLines(true)}</li>
201-
* <li>{@code setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)}</li>
202-
* <li>All other values take their Java defaults, false for boolean, null for objects.</li>
197+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
198+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
199+
* <li>{@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}</li>
200+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (true)}</li>
201+
* <li>{@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}</li>
202+
* <li>All other values take their Java defaults, {@code false} for booleans, {@code null} for object references.</li>
203203
* </ul>
204204
*
205205
* @see Predefined#Default
@@ -774,7 +774,7 @@ public Builder setQuote(final char quoteCharacter) {
774774
*/
775775
public Builder setQuote(final Character quoteCharacter) {
776776
if (isLineBreak(quoteCharacter)) {
777-
throw new IllegalArgumentException("The quoteChar cannot be a line break");
777+
throw new IllegalArgumentException("The quoteCharacter cannot be a line break");
778778
}
779779
this.quoteCharacter = quoteCharacter;
780780
return this;
@@ -988,11 +988,11 @@ public CSVFormat getFormat() {
988988
* The {@link Builder} settings are:
989989
* </p>
990990
* <ul>
991-
* <li>{@code setDelimiter(',')}</li>
992-
* <li>{@code setQuote('"')}</li>
993-
* <li>{@code setRecordSeparator("\r\n")}</li>
994-
* <li>{@code setIgnoreEmptyLines(true)}</li>
995-
* <li>{@code setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)}</li>
991+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
992+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
993+
* <li>{@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}</li>
994+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (true)}</li>
995+
* <li>{@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}</li>
996996
* </ul>
997997
*
998998
* @see Predefined#Default
@@ -1016,14 +1016,14 @@ public CSVFormat getFormat() {
10161016
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
10171017
* </p>
10181018
* <ul>
1019-
* <li>{@code setDelimiter(',')}</li>
1020-
* <li>{@code setQuote('"')}</li>
1021-
* <li>{@code setRecordSeparator("\r\n")}</li>
1022-
* <li>{@code setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)}</li>
1023-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1024-
* <li>{@code setAllowMissingColumnNames(true)}</li>
1025-
* <li>{@code setTrailingData(true)}</li>
1026-
* <li>{@code setLenientEof(true)}</li>
1019+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1020+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
1021+
* <li>{@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}</li>
1022+
* <li>{@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}</li>
1023+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
1024+
* <li>{@link Builder#setAllowMissingColumnNames(boolean) setAllowMissingColumnNames}{@code (true)}</li>
1025+
* <li>{@link Builder#setTrailingData(boolean) setTrailingData}{@code (true)}</li>
1026+
* <li>{@link Builder#setLenientEof(boolean) setLenientEof}{@code (true)}</li>
10271027
* </ul>
10281028
* <p>
10291029
* Note: This is currently like {@link #RFC4180} plus {@link Builder#setAllowMissingColumnNames(boolean) Builder#setAllowMissingColumnNames(true)} and
@@ -1054,10 +1054,10 @@ public CSVFormat getFormat() {
10541054
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
10551055
* </p>
10561056
* <ul>
1057-
* <li>{@code setDelimiter(',')}</li>
1058-
* <li>{@code setEscape('\\')}</li>
1059-
* <li>{@code setQuote("\"")}</li>
1060-
* <li>{@code setRecordSeparator('\n')}</li>
1057+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1058+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('\\')}</li>
1059+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('\"')}</li>
1060+
* <li>{@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}</li>
10611061
* </ul>
10621062
*
10631063
* @see Predefined#MySQL
@@ -1086,9 +1086,9 @@ public CSVFormat getFormat() {
10861086
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
10871087
* </p>
10881088
* <ul>
1089-
* <li>{@code setDelimiter(',')}</li>
1090-
* <li>{@code setQuote("\"")}</li>
1091-
* <li>{@code setRecordSeparator('\n')}</li>
1089+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1090+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('\"')}</li>
1091+
* <li>{@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}</li>
10921092
* </ul>
10931093
*
10941094
* @see Predefined#MySQL
@@ -1124,11 +1124,10 @@ public CSVFormat getFormat() {
11241124
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
11251125
* </p>
11261126
* <ul>
1127-
* <li>{@code setDelimiter(',')}</li>
1128-
* <li>{@code setEscape('"')}</li>
1129-
* <li>{@code setQuote('"')}</li>
1130-
* <li>{@code setQuoteMode(QuoteMode.ALL_NON_NULL)}</li>
1131-
* <li>{@code setSkipHeaderRecord(false)}</li>
1127+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1128+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('"')}</li>
1129+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
1130+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}</li>
11321131
* </ul>
11331132
*
11341133
* @see Predefined#MongoDBCsv
@@ -1142,7 +1141,6 @@ public CSVFormat getFormat() {
11421141
.setEscape(Constants.DOUBLE_QUOTE_CHAR)
11431142
.setQuote(Constants.DOUBLE_QUOTE_CHAR)
11441143
.setQuoteMode(QuoteMode.MINIMAL)
1145-
.setSkipHeaderRecord(false)
11461144
.get();
11471145
// @formatter:off
11481146

@@ -1161,10 +1159,10 @@ public CSVFormat getFormat() {
11611159
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
11621160
* </p>
11631161
* <ul>
1164-
* <li>{@code setDelimiter('\t')}</li>
1165-
* <li>{@code setEscape('"')}</li>
1166-
* <li>{@code setQuote('"')}</li>
1167-
* <li>{@code setQuoteMode(QuoteMode.ALL_NON_NULL)}</li>
1162+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}</li>
1163+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('"')}</li>
1164+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
1165+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}</li>
11681166
* <li>{@code setSkipHeaderRecord(false)}</li>
11691167
* </ul>
11701168
*
@@ -1196,13 +1194,13 @@ public CSVFormat getFormat() {
11961194
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
11971195
* </p>
11981196
* <ul>
1199-
* <li>{@code setDelimiter('\t')}</li>
1200-
* <li>{@code setEscape('\\')}</li>
1201-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1202-
* <li>{@code setQuote(null)}</li>
1203-
* <li>{@code setRecordSeparator('\n')}</li>
1204-
* <li>{@code setNullString("\\N")}</li>
1205-
* <li>{@code setQuoteMode(QuoteMode.ALL_NON_NULL)}</li>
1197+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}</li>
1198+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('\\')}</li>
1199+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
1200+
* <li>{@link Builder#setQuote(Character) setQuote}{@code (null)}</li>
1201+
* <li>{@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}</li>
1202+
* <li>{@link Builder#setNullString(String) setNullString}{@code ("\\N")}</li>
1203+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}</li>
12061204
* </ul>
12071205
*
12081206
* @see Predefined#MySQL
@@ -1235,14 +1233,14 @@ public CSVFormat getFormat() {
12351233
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
12361234
* </p>
12371235
* <ul>
1238-
* <li>{@code setDelimiter(',') // default is {@code FIELDS TERMINATED BY ','}}</li>
1239-
* <li>{@code setEscape('\\')}</li>
1240-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1241-
* <li>{@code setQuote('"') // default is {@code OPTIONALLY ENCLOSED BY '"'}}</li>
1242-
* <li>{@code setNullString("\\N")}</li>
1243-
* <li>{@code setTrim()}</li>
1244-
* <li>{@code setSystemRecordSeparator()}</li>
1245-
* <li>{@code setQuoteMode(QuoteMode.MINIMAL)}</li>
1236+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')} // default is {@code FIELDS TERMINATED BY ','}}</li>
1237+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('\\')}</li>
1238+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
1239+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')} // default is {@code OPTIONALLY ENCLOSED BY '"'}}</li>
1240+
* <li>{@link Builder#setNullString(String) setNullString}{@code ("\\N")}</li>
1241+
* <li>{@link Builder#setTrim(boolean) setTrim}{@code (true)}</li>
1242+
* <li>{@link Builder#setRecordSeparator(String) setRecordSeparator}{@code (System.lineSeparator())}</li>
1243+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.MINIMAL)}</li>
12461244
* </ul>
12471245
*
12481246
* @see Predefined#Oracle
@@ -1275,13 +1273,13 @@ public CSVFormat getFormat() {
12751273
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
12761274
* </p>
12771275
* <ul>
1278-
* <li>{@code setDelimiter(',')}</li>
1279-
* <li>{@code setEscape(null)}</li>
1280-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1281-
* <li>{@code setQuote('"')}</li>
1282-
* <li>{@code setRecordSeparator('\n')}</li>
1283-
* <li>{@code setNullString("")}</li>
1284-
* <li>{@code setQuoteMode(QuoteMode.ALL_NON_NULL)}</li>
1276+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1277+
* <li>{@link Builder#setEscape(Character) setEscape}{@code (null)}</li>
1278+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
1279+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
1280+
* <li>{@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}</li>
1281+
* <li>{@link Builder#setNullString(String) setNullString}{@code ("")}</li>
1282+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}</li>
12851283
* </ul>
12861284
*
12871285
* @see Predefined#MySQL
@@ -1314,13 +1312,13 @@ public CSVFormat getFormat() {
13141312
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
13151313
* </p>
13161314
* <ul>
1317-
* <li>{@code setDelimiter('\t')}</li>
1318-
* <li>{@code setEscape('\\')}</li>
1319-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1320-
* <li>{@code setQuote(null)}</li>
1321-
* <li>{@code setRecordSeparator('\n')}</li>
1322-
* <li>{@code setNullString("\\N")}</li>
1323-
* <li>{@code setQuoteMode(QuoteMode.ALL_NON_NULL)}</li>
1315+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}</li>
1316+
* <li>{@link Builder#setEscape(char) setEscape}{@code ('\\')}</li>
1317+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
1318+
* <li>{@link Builder#setQuote(Character) setQuote}{@code (null)}</li>
1319+
* <li>{@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}</li>
1320+
* <li>{@link Builder#setNullString(String) setNullString}{@code ("\\N")}</li>
1321+
* <li>{@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}</li>
13241322
* </ul>
13251323
*
13261324
* @see Predefined#MySQL
@@ -1348,10 +1346,10 @@ public CSVFormat getFormat() {
13481346
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
13491347
* </p>
13501348
* <ul>
1351-
* <li>{@code setDelimiter(',')}</li>
1352-
* <li>{@code setQuote('"')}</li>
1353-
* <li>{@code setRecordSeparator("\r\n")}</li>
1354-
* <li>{@code setIgnoreEmptyLines(false)}</li>
1349+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code (',')}</li>
1350+
* <li>{@link Builder#setQuote(char) setQuote}{@code ('"')}</li>
1351+
* <li>{@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}</li>
1352+
* <li>{@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}</li>
13551353
* </ul>
13561354
*
13571355
* @see Predefined#RFC4180
@@ -1367,8 +1365,8 @@ public CSVFormat getFormat() {
13671365
* The {@link Builder} settings are the {@link #DEFAULT} <em>with</em>:
13681366
* </p>
13691367
* <ul>
1370-
* <li>{@code setDelimiter('\t')}</li>
1371-
* <li>{@code setIgnoreSurroundingSpaces(true)}</li>
1368+
* <li>{@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}</li>
1369+
* <li>{@link Builder#setIgnoreSurroundingSpaces(boolean) setIgnoreSurroundingSpaces}{@code (true)}</li>
13721370
* </ul>
13731371
*
13741372
* @see Predefined#TDF

0 commit comments

Comments
 (0)