/usr/share/doc/libcommons-csv-java/api/org/apache/commons/csv/CSVFormat.html is in libcommons-csv-java-doc 1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CSVFormat (Apache Commons CSV 1.2 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CSVFormat (Apache Commons CSV 1.2 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/apache/commons/csv/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CSVFormat.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/csv/CSVFormat.html" target="_top">Frames</a></li>
<li><a href="CSVFormat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.csv</div>
<h2 title="Class CSVFormat" class="title">Class CSVFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.csv.CSVFormat</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">CSVFormat</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Specifies the format of a CSV file and parses input.
<h2>Using predefined formats</h2>
<p>
You can use one of the predefined formats:
</p>
<ul>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT"><code>DEFAULT</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL"><code>EXCEL</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL"><code>MYSQL</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF"><code>TDF</code></a></li>
</ul>
<p>
For example:
</p>
<pre>
CSVParser parser = CSVFormat.EXCEL.parse(reader);
</pre>
<p>
The <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a> provides static methods to parse other input types, for example:
</p>
<pre>
CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL);
</pre>
<h2>Defining formats</h2>
<p>
You can extend a format by calling the <code>with</code> methods. For example:
</p>
<pre>
CSVFormat.EXCEL.withNullString("N/A").withIgnoreSurroundingSpaces(true);
</pre>
<h2>Defining column names</h2>
<p>
To define the column names you want to use to access records, write:
</p>
<pre>
CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3");
</pre>
<p>
Calling <a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.lang.String...)"><code>withHeader(String...)</code></a> let's you use the given names to address values in a <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecord</code></a>, and
assumes that your CSV source does not contain a first record that also defines column names.
If it does, then you are overriding this metadata with your names and you should skip the first record by calling
<a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord(boolean)"><code>withSkipHeaderRecord(boolean)</code></a> with <code>true</code>.
</p>
<h2>Parsing</h2>
<p>
You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write:
</p>
<pre>
Reader in = ...;
CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3").parse(in);
</pre>
<p>
For other input types, like resources, files, and URLs, use the static methods on <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a>.
</p>
<h2>Referencing columns safely</h2>
<p>
If your source contains a header record, you can simplify your code and safely reference columns, by using
<a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.lang.String...)"><code>withHeader(String...)</code></a> with no arguments:
</p>
<pre>
CSVFormat.EXCEL.withHeader();
</pre>
<p>
This causes the parser to read the first record and use its values as column names.
Then, call one of the <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecord</code></a> get method that takes a String column name argument:
</p>
<pre>
String value = record.get("Col1");
</pre>
<p>
This makes your code impervious to changes in column order in the CSV file.
</p>
<h2>Notes</h2>
<p>
This class is immutable.
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Id: CSVFormat.java 1695190 2015-08-11 02:14:33Z ggregory $</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv">CSVFormat.Predefined</a></strong></code>
<div class="block">Predefines formats.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">Standard comma separated format, as for <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> but allowing empty lines.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL">EXCEL</a></strong></code>
<div class="block">Excel file format (using a comma as the value delimiter).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL">MYSQL</a></strong></code>
<div class="block">Default MySQL format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA INFILE</code> operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180">RFC4180</a></strong></code>
<div class="block">Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF">TDF</a></strong></code>
<div class="block">Tab-delimited format.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#format(java.lang.Object...)">format</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</code>
<div class="block">Formats the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getAllowMissingColumnNames()">getAllowMissingColumnNames</a></strong>()</code>
<div class="block">Specifies whether missing column names are allowed when parsing the header line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getCommentMarker()">getCommentMarker</a></strong>()</code>
<div class="block">Returns the character marking the start of a line comment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getDelimiter()">getDelimiter</a></strong>()</code>
<div class="block">Returns the character delimiting the values (typically ';', ',' or '\t').</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getEscapeCharacter()">getEscapeCharacter</a></strong>()</code>
<div class="block">Returns the escape character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getHeader()">getHeader</a></strong>()</code>
<div class="block">Returns a copy of the header array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getHeaderComments()">getHeaderComments</a></strong>()</code>
<div class="block">Returns a copy of the header comment array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreEmptyLines()">getIgnoreEmptyLines</a></strong>()</code>
<div class="block">Specifies whether empty lines between records are ignored when parsing input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreSurroundingSpaces()">getIgnoreSurroundingSpaces</a></strong>()</code>
<div class="block">Specifies whether spaces around values are ignored when parsing input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getNullString()">getNullString</a></strong>()</code>
<div class="block">Gets the String to convert to and from <code>null</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteCharacter()">getQuoteCharacter</a></strong>()</code>
<div class="block">Returns the character used to encapsulate values containing special characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteMode()">getQuoteMode</a></strong>()</code>
<div class="block">Returns the quote policy output fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getRecordSeparator()">getRecordSeparator</a></strong>()</code>
<div class="block">Returns the record separator delimiting output records.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#getSkipHeaderRecord()">getSkipHeaderRecord</a></strong>()</code>
<div class="block">Returns whether to skip the header record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#isCommentMarkerSet()">isCommentMarkerSet</a></strong>()</code>
<div class="block">Specifies whether comments are supported by this format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#isEscapeCharacterSet()">isEscapeCharacterSet</a></strong>()</code>
<div class="block">Returns whether escape are being processed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#isNullStringSet()">isNullStringSet</a></strong>()</code>
<div class="block">Returns whether a nullString has been defined.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#isQuoteCharacterSet()">isQuoteCharacterSet</a></strong>()</code>
<div class="block">Returns whether a quoteChar has been defined.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#newFormat(char)">newFormat</a></strong>(char delimiter)</code>
<div class="block">Creates a new CSV format with the specified delimiter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#parse(java.io.Reader)">parse</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)</code>
<div class="block">Parses the specified content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#print(java.lang.Appendable)">print</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a> out)</code>
<div class="block">Prints to the specified output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#toString()">toString</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</code>
<div class="block">Gets one of the predefined formats from <a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><code>CSVFormat.Predefined</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames()">withAllowMissingColumnNames</a></strong>()</code>
<div class="block">Sets the missing column names behavior of the format to <code>true</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames(boolean)">withAllowMissingColumnNames</a></strong>(boolean allowMissingColumnNames)</code>
<div class="block">Sets the missing column names behavior of the format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker(char)">withCommentMarker</a></strong>(char commentMarker)</code>
<div class="block">Sets the comment start marker of the format to the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker(java.lang.Character)">withCommentMarker</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> commentMarker)</code>
<div class="block">Sets the comment start marker of the format to the specified character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withDelimiter(char)">withDelimiter</a></strong>(char delimiter)</code>
<div class="block">Sets the delimiter of the format to the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape(char)">withEscape</a></strong>(char escape)</code>
<div class="block">Sets the escape character of the format to the specified character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape(java.lang.Character)">withEscape</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> escape)</code>
<div class="block">Sets the escape character of the format to the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.sql.ResultSet)">withHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)</code>
<div class="block">Sets the header of the format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.sql.ResultSetMetaData)">withHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData)</code>
<div class="block">Sets the header of the format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.lang.String...)">withHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... header)</code>
<div class="block">Sets the header of the format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeaderComments(java.lang.Object...)">withHeaderComments</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... headerComments)</code>
<div class="block">Sets the header comments of the format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines()">withIgnoreEmptyLines</a></strong>()</code>
<div class="block">Sets the empty line skipping behavior of the format to <code>true</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines(boolean)">withIgnoreEmptyLines</a></strong>(boolean ignoreEmptyLines)</code>
<div class="block">Sets the empty line skipping behavior of the format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces()">withIgnoreSurroundingSpaces</a></strong>()</code>
<div class="block">Sets the trimming behavior of the format to <code>true</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces(boolean)">withIgnoreSurroundingSpaces</a></strong>(boolean ignoreSurroundingSpaces)</code>
<div class="block">Sets the trimming behavior of the format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withNullString(java.lang.String)">withNullString</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nullString)</code>
<div class="block">Performs conversions to and from null for strings on input and output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote(char)">withQuote</a></strong>(char quoteChar)</code>
<div class="block">Sets the quoteChar of the format to the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote(java.lang.Character)">withQuote</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> quoteChar)</code>
<div class="block">Sets the quoteChar of the format to the specified character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuoteMode(org.apache.commons.csv.QuoteMode)">withQuoteMode</a></strong>(<a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a> quoteModePolicy)</code>
<div class="block">Sets the output quote policy of the format to the specified value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator(char)">withRecordSeparator</a></strong>(char recordSeparator)</code>
<div class="block">Sets the record separator of the format to the specified character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator(java.lang.String)">withRecordSeparator</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> recordSeparator)</code>
<div class="block">Sets the record separator of the format to the specified String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord()">withSkipHeaderRecord</a></strong>()</code>
<div class="block">Sets skipping the header record to <code>true</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord(boolean)">withSkipHeaderRecord</a></strong>(boolean skipHeaderRecord)</code>
<div class="block">Sets whether to skip the header record.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> DEFAULT</pre>
<div class="block">Standard comma separated format, as for <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> but allowing empty lines.
<p>
Settings are:
</p>
<ul>
<li>withDelimiter(',')</li>
<li>withQuote('"')</li>
<li>withRecordSeparator("\r\n")</li>
<li>withIgnoreEmptyLines(true)</li>
</ul></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#Default"><code>CSVFormat.Predefined.Default</code></a></dd></dl>
</li>
</ul>
<a name="RFC4180">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RFC4180</h4>
<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> RFC4180</pre>
<div class="block">Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.
<p>
Settings are:
</p>
<ul>
<li>withDelimiter(',')</li>
<li>withQuote('"')</li>
<li>withRecordSeparator("\r\n")</li>
<li>withIgnoreEmptyLines(false)</li>
</ul></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#RFC4180"><code>CSVFormat.Predefined.RFC4180</code></a></dd></dl>
</li>
</ul>
<a name="EXCEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXCEL</h4>
<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> EXCEL</pre>
<div class="block">Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is
locale dependent, it might be necessary to customize this format to accommodate to your regional settings.
<p>
For example for parsing or generating a CSV file on a French system the following format will be used:
</p>
<pre>
CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');
</pre>
<p>
Settings are:
</p>
<ul>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#withDelimiter(char)"><code>withDelimiter(',')</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote(char)"><code>withQuote('"')</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator(java.lang.String)"><code>withRecordSeparator("\r\n")</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines(boolean)"><code>withIgnoreEmptyLines(false)</code></a></li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames(boolean)"><code>withAllowMissingColumnNames(true)</code></a></li>
</ul>
<p>
Note: this is currently like <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> plus <a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames(boolean)"><code>withAllowMissingColumnNames(true)</code></a>.
</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#Excel"><code>CSVFormat.Predefined.Excel</code></a></dd></dl>
</li>
</ul>
<a name="TDF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TDF</h4>
<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> TDF</pre>
<div class="block">Tab-delimited format.
<p>
Settings are:
</p>
<ul>
<li>withDelimiter('\t')</li>
<li>withQuote('"')</li>
<li>withRecordSeparator("\r\n")</li>
<li>withIgnoreSurroundingSpaces(true)</li>
</ul></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#TDF"><code>CSVFormat.Predefined.TDF</code></a></dd></dl>
</li>
</ul>
<a name="MYSQL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MYSQL</h4>
<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> MYSQL</pre>
<div class="block">Default MySQL format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA INFILE</code> operations.
<p>
This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special
characters are escaped with '\'.
</p>
<p>
Settings are:
</p>
<ul>
<li>withDelimiter('\t')</li>
<li>withQuote(null)</li>
<li>withRecordSeparator('\n')</li>
<li>withIgnoreEmptyLines(false)</li>
<li>withEscape('\\')</li>
</ul></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>,
<a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">
http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newFormat(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newFormat</h4>
<pre>public static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> newFormat(char delimiter)</pre>
<div class="block">Creates a new CSV format with the specified delimiter.
<p>
Use this method if you want to create a CSVFormat from scratch. All fields but the delimiter will be initialized
with null/false.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delimiter</code> - the char used for value separation, must not be a line break character</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new CSV format.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the delimiter is a line break character</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT"><code>DEFAULT</code></a>,
<a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a>,
<a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL"><code>MYSQL</code></a>,
<a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL"><code>EXCEL</code></a>,
<a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF"><code>TDF</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</pre>
<div class="block">Gets one of the predefined formats from <a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><code>CSVFormat.Predefined</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - name</dd>
<dt><span class="strong">Returns:</span></dt><dd>one of the predefined formats</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="format(java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</pre>
<div class="block">Formats the specified values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the values to format</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted values</dd></dl>
</li>
</ul>
<a name="getCommentMarker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommentMarker</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> getCommentMarker()</pre>
<div class="block">Returns the character marking the start of a line comment.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the comment start marker, may be <code>null</code></dd></dl>
</li>
</ul>
<a name="getDelimiter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelimiter</h4>
<pre>public char getDelimiter()</pre>
<div class="block">Returns the character delimiting the values (typically ';', ',' or '\t').</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the delimiter character</dd></dl>
</li>
</ul>
<a name="getEscapeCharacter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEscapeCharacter</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> getEscapeCharacter()</pre>
<div class="block">Returns the escape character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the escape character, may be <code>null</code></dd></dl>
</li>
</ul>
<a name="getHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getHeader()</pre>
<div class="block">Returns a copy of the header array.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of the header array; <code>null</code> if disabled, the empty array if to be read from the file</dd></dl>
</li>
</ul>
<a name="getHeaderComments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderComments</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getHeaderComments()</pre>
<div class="block">Returns a copy of the header comment array.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of the header comment array; <code>null</code> if disabled.</dd></dl>
</li>
</ul>
<a name="getAllowMissingColumnNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowMissingColumnNames</h4>
<pre>public boolean getAllowMissingColumnNames()</pre>
<div class="block">Specifies whether missing column names are allowed when parsing the header line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if missing column names are allowed when parsing the header line, <code>false</code> to throw an
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a>.</dd></dl>
</li>
</ul>
<a name="getIgnoreEmptyLines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreEmptyLines</h4>
<pre>public boolean getIgnoreEmptyLines()</pre>
<div class="block">Specifies whether empty lines between records are ignored when parsing input.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if empty lines between records are ignored, <code>false</code> if they are turned into empty
records.</dd></dl>
</li>
</ul>
<a name="getIgnoreSurroundingSpaces()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreSurroundingSpaces</h4>
<pre>public boolean getIgnoreSurroundingSpaces()</pre>
<div class="block">Specifies whether spaces around values are ignored when parsing input.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if spaces around values are ignored, <code>false</code> if they are treated as part of the value.</dd></dl>
</li>
</ul>
<a name="getNullString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNullString</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNullString()</pre>
<div class="block">Gets the String to convert to and from <code>null</code>.
<ul>
<li>
<strong>Reading:</strong> Converts strings equal to the given <code>nullString</code> to <code>null</code> when reading
records.</li>
<li>
<strong>Writing:</strong> Writes <code>null</code> as the given <code>nullString</code> when writing records.</li>
</ul></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the String to convert to and from <code>null</code>. No substitution occurs if <code>null</code></dd></dl>
</li>
</ul>
<a name="getQuoteCharacter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuoteCharacter</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> getQuoteCharacter()</pre>
<div class="block">Returns the character used to encapsulate values containing special characters.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the quoteChar character, may be <code>null</code></dd></dl>
</li>
</ul>
<a name="getQuoteMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuoteMode</h4>
<pre>public <a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a> getQuoteMode()</pre>
<div class="block">Returns the quote policy output fields.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the quote policy</dd></dl>
</li>
</ul>
<a name="getRecordSeparator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordSeparator</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRecordSeparator()</pre>
<div class="block">Returns the record separator delimiting output records.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the record separator</dd></dl>
</li>
</ul>
<a name="getSkipHeaderRecord()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSkipHeaderRecord</h4>
<pre>public boolean getSkipHeaderRecord()</pre>
<div class="block">Returns whether to skip the header record.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether to skip the header record.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="isCommentMarkerSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCommentMarkerSet</h4>
<pre>public boolean isCommentMarkerSet()</pre>
<div class="block">Specifies whether comments are supported by this format.
Note that the comment introducer character is only recognized at the start of a line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> is comments are supported, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="isEscapeCharacterSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEscapeCharacterSet</h4>
<pre>public boolean isEscapeCharacterSet()</pre>
<div class="block">Returns whether escape are being processed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if escapes are processed</dd></dl>
</li>
</ul>
<a name="isNullStringSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNullStringSet</h4>
<pre>public boolean isNullStringSet()</pre>
<div class="block">Returns whether a nullString has been defined.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a nullString is defined</dd></dl>
</li>
</ul>
<a name="isQuoteCharacterSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isQuoteCharacterSet</h4>
<pre>public boolean isQuoteCharacterSet()</pre>
<div class="block">Returns whether a quoteChar has been defined.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a quoteChar is defined</dd></dl>
</li>
</ul>
<a name="parse(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a> parse(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Parses the specified content.
<p>
See also the various static parse methods on <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the input stream</dd>
<dt><span class="strong">Returns:</span></dt><dd>a parser over a stream of <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecord</code></a>s.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="print(java.lang.Appendable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a> print(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a> out)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Prints to the specified output.
<p>
See also <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><code>CSVPrinter</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the output</dd>
<dt><span class="strong">Returns:</span></dt><dd>a printer to an output</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if the optional header cannot be printed.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="withCommentMarker(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCommentMarker</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withCommentMarker(char commentMarker)</pre>
<div class="block">Sets the comment start marker of the format to the specified character.
Note that the comment start character is only recognized at the start of a line.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>commentMarker</code> - the comment start marker</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this one but with the specified character as the comment start marker</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withCommentMarker(java.lang.Character)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCommentMarker</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withCommentMarker(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> commentMarker)</pre>
<div class="block">Sets the comment start marker of the format to the specified character.
Note that the comment start character is only recognized at the start of a line.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>commentMarker</code> - the comment start marker, use <code>null</code> to disable</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this one but with the specified character as the comment start marker</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withDelimiter(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDelimiter</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withDelimiter(char delimiter)</pre>
<div class="block">Sets the delimiter of the format to the specified character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delimiter</code> - the delimiter character</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this with the specified character as delimiter</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withEscape(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEscape</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withEscape(char escape)</pre>
<div class="block">Sets the escape character of the format to the specified character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>escape</code> - the escape character</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to his but with the specified character as the escape character</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withEscape(java.lang.Character)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEscape</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withEscape(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> escape)</pre>
<div class="block">Sets the escape character of the format to the specified character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>escape</code> - the escape character, use <code>null</code> to disable</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified character as the escape character</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withHeader(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHeader</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... header)</pre>
<div class="block">Sets the header of the format. The header can either be parsed automatically from the input file with:
<pre>
CSVFormat format = aformat.withHeader();
</pre>
or specified manually with:
<pre>
CSVFormat format = aformat.withHeader("name", "email", "phone");
</pre>
<p>
The header is also used by the <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><code>CSVPrinter</code></a>..
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - the header, <code>null</code> if disabled, empty if parsed automatically, user specified otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified header</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord(boolean)"><code>withSkipHeaderRecord(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="withHeader(java.sql.ResultSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHeader</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Sets the header of the format. The header can either be parsed automatically from the input file with:
<pre>
CSVFormat format = aformat.withHeader();
</pre>
or specified manually with:
<pre>
CSVFormat format = aformat.withHeader(resultSet);
</pre>
<p>
The header is also used by the <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><code>CSVPrinter</code></a>..
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resultSet</code> - the resultSet for the header, <code>null</code> if disabled, empty if parsed automatically, user specified
otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified header</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - SQLException if a database access error occurs or this method is called on a closed result set.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="withHeader(java.sql.ResultSetMetaData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHeader</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Sets the header of the format. The header can either be parsed automatically from the input file with:
<pre>
CSVFormat format = aformat.withHeader();
</pre>
or specified manually with:
<pre>
CSVFormat format = aformat.withHeader(metaData);
</pre>
<p>
The header is also used by the <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><code>CSVPrinter</code></a>..
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>metaData</code> - the metaData for the header, <code>null</code> if disabled, empty if parsed automatically, user specified
otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified header</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - SQLException if a database access error occurs or this method is called on a closed result set.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="withHeaderComments(java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHeaderComments</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withHeaderComments(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... headerComments)</pre>
<div class="block">Sets the header comments of the format. The comments will be printed first, before the headers. This setting is
ignored by the parser.
<pre>
CSVFormat format = aformat.withHeaderComments("Generated by Apache Commons CSV 1.1.", new Date());
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>headerComments</code> - the headerComments which will be printed by the Printer before the actual CSV data.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified header</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord(boolean)"><code>withSkipHeaderRecord(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="withAllowMissingColumnNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAllowMissingColumnNames</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withAllowMissingColumnNames()</pre>
<div class="block">Sets the missing column names behavior of the format to <code>true</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified missing column names behavior.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames(boolean)"><code>withAllowMissingColumnNames(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="withAllowMissingColumnNames(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAllowMissingColumnNames</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withAllowMissingColumnNames(boolean allowMissingColumnNames)</pre>
<div class="block">Sets the missing column names behavior of the format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>allowMissingColumnNames</code> - the missing column names behavior, <code>true</code> to allow missing column names in the header line,
<code>false</code> to cause an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> to be thrown.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified missing column names behavior.</dd></dl>
</li>
</ul>
<a name="withIgnoreEmptyLines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withIgnoreEmptyLines</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withIgnoreEmptyLines()</pre>
<div class="block">Sets the empty line skipping behavior of the format to <code>true</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified empty line skipping behavior.</dd><dt><span class="strong">Since:</span></dt>
<dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines(boolean)"><code>withIgnoreEmptyLines(boolean)</code></a>, 1.1</dd></dl>
</li>
</ul>
<a name="withIgnoreEmptyLines(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withIgnoreEmptyLines</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withIgnoreEmptyLines(boolean ignoreEmptyLines)</pre>
<div class="block">Sets the empty line skipping behavior of the format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreEmptyLines</code> - the empty line skipping behavior, <code>true</code> to ignore the empty lines between the records,
<code>false</code> to translate empty lines to empty records.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified empty line skipping behavior.</dd></dl>
</li>
</ul>
<a name="withIgnoreSurroundingSpaces()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withIgnoreSurroundingSpaces</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withIgnoreSurroundingSpaces()</pre>
<div class="block">Sets the trimming behavior of the format to <code>true</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified trimming behavior.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces(boolean)"><code>withIgnoreSurroundingSpaces(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="withIgnoreSurroundingSpaces(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withIgnoreSurroundingSpaces</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces)</pre>
<div class="block">Sets the trimming behavior of the format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreSurroundingSpaces</code> - the trimming behavior, <code>true</code> to remove the surrounding spaces, <code>false</code> to leave the
spaces as is.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified trimming behavior.</dd></dl>
</li>
</ul>
<a name="withNullString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNullString</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withNullString(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nullString)</pre>
<div class="block">Performs conversions to and from null for strings on input and output.
<ul>
<li>
<strong>Reading:</strong> Converts strings equal to the given <code>nullString</code> to <code>null</code> when reading
records.</li>
<li>
<strong>Writing:</strong> Writes <code>null</code> as the given <code>nullString</code> when writing records.</li>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nullString</code> - the String to convert to and from <code>null</code>. No substitution occurs if <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified null conversion string.</dd></dl>
</li>
</ul>
<a name="withQuote(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withQuote</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withQuote(char quoteChar)</pre>
<div class="block">Sets the quoteChar of the format to the specified character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>quoteChar</code> - the quoteChar character</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified character as quoteChar</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withQuote(java.lang.Character)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withQuote</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withQuote(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> quoteChar)</pre>
<div class="block">Sets the quoteChar of the format to the specified character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>quoteChar</code> - the quoteChar character, use <code>null</code> to disable</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified character as quoteChar</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown if the specified character is a line break</dd></dl>
</li>
</ul>
<a name="withQuoteMode(org.apache.commons.csv.QuoteMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withQuoteMode</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withQuoteMode(<a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a> quoteModePolicy)</pre>
<div class="block">Sets the output quote policy of the format to the specified value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>quoteModePolicy</code> - the quote policy to use for output.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the specified quote policy</dd></dl>
</li>
</ul>
<a name="withRecordSeparator(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withRecordSeparator</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withRecordSeparator(char recordSeparator)</pre>
<div class="block">Sets the record separator of the format to the specified character.
<p>
<strong>Note:</strong> This setting is only used during printing and does not affect parsing. Parsing currently
only works for inputs with '\n', '\r' and "\r\n"
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordSeparator</code> - the record separator to use for output.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the the specified output record separator</dd></dl>
</li>
</ul>
<a name="withRecordSeparator(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withRecordSeparator</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withRecordSeparator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> recordSeparator)</pre>
<div class="block">Sets the record separator of the format to the specified String.
<p>
<strong>Note:</strong> This setting is only used during printing and does not affect parsing. Parsing currently
only works for inputs with '\n', '\r' and "\r\n"
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordSeparator</code> - the record separator to use for output.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the the specified output record separator</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if recordSeparator is none of CR, LF or CRLF</dd></dl>
</li>
</ul>
<a name="withSkipHeaderRecord()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSkipHeaderRecord</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withSkipHeaderRecord()</pre>
<div class="block">Sets skipping the header record to <code>true</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the the specified skipHeaderRecord setting.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord(boolean)"><code>withSkipHeaderRecord(boolean)</code></a>,
<a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.lang.String...)"><code>withHeader(String...)</code></a></dd></dl>
</li>
</ul>
<a name="withSkipHeaderRecord(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withSkipHeaderRecord</h4>
<pre>public <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> withSkipHeaderRecord(boolean skipHeaderRecord)</pre>
<div class="block">Sets whether to skip the header record.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>skipHeaderRecord</code> - whether to skip the header record.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new CSVFormat that is equal to this but with the the specified skipHeaderRecord setting.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader(java.lang.String...)"><code>withHeader(String...)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/apache/commons/csv/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CSVFormat.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/csv/CSVFormat.html" target="_top">Frames</a></li>
<li><a href="CSVFormat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p>
</body>
</html>
|