You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by gg...@apache.org on 2018/01/29 17:25:24 UTC
svn commit: r1024533 [3/46] - in
/websites/production/commons/content/proper/commons-csv/archives/1.5: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/commons/
apidocs/org/apache/commons/csv/ apidocs/org/apache/commons/csv/class-use/
ap...
Added: websites/production/commons/content/proper/commons-csv/archives/1.5/apidocs/org/apache/commons/csv/CSVFormat.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/archives/1.5/apidocs/org/apache/commons/csv/CSVFormat.html (added)
+++ websites/production/commons/content/proper/commons-csv/archives/1.5/apidocs/org/apache/commons/csv/CSVFormat.html Mon Jan 29 17:25:21 2018
@@ -0,0 +1,2039 @@
+<!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.5 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.5 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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.156">CSVFormat</a>
+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">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#INFORMIX_UNLOAD">INFORMIX_UNLOAD</a></strong></code>
+<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation.</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#INFORMIX_UNLOAD_CSV">INFORMIX_UNLOAD_CSV</a></strong></code>
+<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation (escaping is disabled.)</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#POSTGRESQL_CSV">POSTGRESQL_CSV</a></strong></code>
+<div class="block">Default PostgreSQL CSV format used by the <code>COPY</code> operation.</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#POSTGRESQL_TEXT">POSTGRESQL_TEXT</a></strong></code>
+<div class="block">Default PostgreSQL text format used by the <code>COPY</code> operation.</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#getIgnoreHeaderCase()">getIgnoreHeaderCase</a></strong>()</code>
+<div class="block">Specifies whether header names will be accessed ignoring case.</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#getIgnoreSurroundingSpaces()">getIgnoreSurroundingSpaces</a></strong>()</code>
+<div class="block">Specifies whether spaces around values are ignored when parsing input.</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#getNullString()">getNullString</a></strong>()</code>
+<div class="block">Gets the String to convert to and from <code>null</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<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="rowColor">
+<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="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#getRecordSeparator()">getRecordSeparator</a></strong>()</code>
+<div class="block">Returns the record separator delimiting output records.</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#getSkipHeaderRecord()">getSkipHeaderRecord</a></strong>()</code>
+<div class="block">Returns whether to skip the header record.</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#getTrailingDelimiter()">getTrailingDelimiter</a></strong>()</code>
+<div class="block">Returns whether to add a trailing delimiter.</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#getTrim()">getTrim</a></strong>()</code>
+<div class="block">Returns whether to trim leading and trailing blanks.</div>
+</td>
+</tr>
+<tr class="altColor">
+<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="rowColor">
+<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="altColor">
+<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="rowColor">
+<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="altColor">
+<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="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#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="altColor">
+<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="rowColor">
+<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="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.io.File,%20java.nio.charset.Charset)">print</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> out,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)</code>
+<div class="block">Prints to the specified output.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#print(java.lang.Object,%20java.lang.Appendable,%20boolean)">print</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> value,
+ <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,
+ boolean newRecord)</code>
+<div class="block">Prints the <code>value</code> as the next value on the line to <code>out</code>.</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.nio.file.Path,%20java.nio.charset.Charset)">print</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> out,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)</code>
+<div class="block">Prints to the specified output.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<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#printer()">printer</a></strong>()</code>
+<div class="block">Prints to the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang"><code>System.out</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#println(java.lang.Appendable)">println</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">Outputs the trailing delimiter (if set) followed by the record separator (if set).</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVFormat.html#printRecord(java.lang.Appendable,%20java.lang.Object...)">printRecord</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,
+ <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">Prints the given <code>values</code> to <code>out</code> as a single record of delimiter separated values followed by the
+ record separator.</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#toString()">toString</a></strong>()</code> </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#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="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()">withAllowMissingColumnNames</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the missing column names behavior of the format set 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#withAllowMissingColumnNames(boolean)">withAllowMissingColumnNames</a></strong>(boolean allowMissingColumnNames)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the missing column names behavior of the format set to the given 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#withCommentMarker(char)">withCommentMarker</a></strong>(char commentMarker)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the comment start marker of the format set 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#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">Returns a new <code>CSVFormat</code> with the comment start marker of the format set 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#withDelimiter(char)">withDelimiter</a></strong>(char delimiter)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the delimiter of the format set 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(char)">withEscape</a></strong>(char escape)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the escape character of the format set 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(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">Returns a new <code>CSVFormat</code> with the escape character of the format set 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#withFirstRecordAsHeader()">withFirstRecordAsHeader</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> using the first record as header.</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.Class)">withHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><?>> headerEnum)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the header of the format defined by the enum class.</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.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">Returns a new <code>CSVFormat</code> with the header of the format set from the result set metadata.</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.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">Returns a new <code>CSVFormat</code> with the header of the format set from the result set metadata.</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.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">Returns a new <code>CSVFormat</code> with the header of the format set to the given values.</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#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">Returns a new <code>CSVFormat</code> with the header comments of the format set to the given values.</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()">withIgnoreEmptyLines</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the empty line skipping behavior of the format set 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#withIgnoreEmptyLines(boolean)">withIgnoreEmptyLines</a></strong>(boolean ignoreEmptyLines)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the empty line skipping behavior of the format set to the given value.</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#withIgnoreHeaderCase()">withIgnoreHeaderCase</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the header ignore case behavior set 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#withIgnoreHeaderCase(boolean)">withIgnoreHeaderCase</a></strong>(boolean ignoreHeaderCase)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with whether header names should be accessed ignoring case.</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()">withIgnoreSurroundingSpaces</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the trimming behavior of the format set 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#withIgnoreSurroundingSpaces(boolean)">withIgnoreSurroundingSpaces</a></strong>(boolean ignoreSurroundingSpaces)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the trimming behavior of the format set to the given value.</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#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">Returns a new <code>CSVFormat</code> with conversions to and from null for strings on input and output.</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(char)">withQuote</a></strong>(char quoteChar)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the quoteChar of the format set 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#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">Returns a new <code>CSVFormat</code> with the quoteChar of the format set 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#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">Returns a new <code>CSVFormat</code> with the output quote policy of the format set to the specified value.</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(char)">withRecordSeparator</a></strong>(char recordSeparator)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with the record separator of the format set 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#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">Returns a new <code>CSVFormat</code> with the record separator of the format set to the specified String.</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()">withSkipHeaderRecord</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> with skipping the header record set 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#withSkipHeaderRecord(boolean)">withSkipHeaderRecord</a></strong>(boolean skipHeaderRecord)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with whether to skip the header record.</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#withTrailingDelimiter()">withTrailingDelimiter</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> to add a trailing delimiter.</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#withTrailingDelimiter(boolean)">withTrailingDelimiter</a></strong>(boolean trailingDelimiter)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with whether to add a trailing delimiter.</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#withTrim()">withTrim</a></strong>()</code>
+<div class="block">Returns a new <code>CSVFormat</code> to trim leading and trailing blanks.</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#withTrim(boolean)">withTrim</a></strong>(boolean trim)</code>
+<div class="block">Returns a new <code>CSVFormat</code> with whether to trim leading and trailing blanks.</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-ex
ternal=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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.244">DEFAULT</a></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="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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.277">EXCEL</a></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="INFORMIX_UNLOAD">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INFORMIX_UNLOAD</h4>
+<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.307">INFORMIX_UNLOAD</a></pre>
+<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation.
+
+ <p>
+ This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special
+ characters are escaped with <code>'\'</code>. The default NULL string is <code>"\\N"</code>.
+ </p>
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuote("\"")</li>
+ <li>withRecordSeparator('\n')</li>
+ <li>withEscape('\\')</li>
+ </ul></div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>1.3</dd>
+<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://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm">
+ http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a></dd></dl>
+</li>
+</ul>
+<a name="INFORMIX_UNLOAD_CSV">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INFORMIX_UNLOAD_CSV</h4>
+<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.338">INFORMIX_UNLOAD_CSV</a></pre>
+<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation (escaping is disabled.)
+
+ <p>
+ This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special
+ characters are escaped with <code>'\'</code>. The default NULL string is <code>"\\N"</code>.
+ </p>
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuote("\"")</li>
+ <li>withRecordSeparator('\n')</li>
+ </ul></div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>1.3</dd>
+<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://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm">
+ http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a></dd></dl>
+</li>
+</ul>
+<a name="MYSQL">
+<!-- -->
+</a>
+<ul class="blockList">
+<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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.370">MYSQL</a></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 <code>'\'</code>. The default NULL string is <code>"\\N"</code>.
+ </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>
+ <li>withNullString("\\N")</li>
+ <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</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>
+<a name="POSTGRESQL_CSV">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>POSTGRESQL_CSV</h4>
+<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.407">POSTGRESQL_CSV</a></pre>
+<div class="block">Default PostgreSQL CSV format used by the <code>COPY</code> operation.
+
+ <p>
+ This is a comma-delimited format with a LF character as the line separator. Values are double quoted and special
+ characters are escaped with <code>'"'</code>. The default NULL string is <code>""</code>.
+ </p>
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuote('"')</li>
+ <li>withRecordSeparator('\n')</li>
+ <li>withIgnoreEmptyLines(false)</li>
+ <li>withEscape('\\')</li>
+ <li>withNullString("")</li>
+ <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</li>
+ </ul></div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>1.5</dd>
+<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>
+<a name="POSTGRESQL_TEXT">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>POSTGRESQL_TEXT</h4>
+<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.444">POSTGRESQL_TEXT</a></pre>
+<div class="block">Default PostgreSQL text format used by the <code>COPY</code> operation.
+
+ <p>
+ This is a tab-delimited format with a LF character as the line separator. Values are double quoted and special
+ characters are escaped with <code>'"'</code>. The default NULL string is <code>"\\N"</code>.
+ </p>
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter('\t')</li>
+ <li>withQuote('"')</li>
+ <li>withRecordSeparator('\n')</li>
+ <li>withIgnoreEmptyLines(false)</li>
+ <li>withEscape('\\')</li>
+ <li>withNullString("\\N")</li>
+ <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</li>
+ </ul></div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>1.5</dd>
+<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>
+<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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.469">RFC4180</a></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="TDF">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.489">TDF</a></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>
+</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.538">newFormat</a>(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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.551">valueOf</a>(<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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.651">equals</a>(<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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.726">format</a>(<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="getAllowMissingColumnNames()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllowMissingColumnNames</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.743">getAllowMissingColumnNames</a>()</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="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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.752">getCommentMarker</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.761">getDelimiter</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.770">getEscapeCharacter</a>()</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>[] <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.779">getHeader</a>()</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>[] <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.788">getHeaderComments</a>()</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="getIgnoreEmptyLines()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getIgnoreEmptyLines</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.798">getIgnoreEmptyLines</a>()</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="getIgnoreHeaderCase()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getIgnoreHeaderCase</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.808">getIgnoreHeaderCase</a>()</pre>
+<div class="block">Specifies whether header names will be accessed ignoring case.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if header names cases are ignored, <code>false</code> if they are case sensitive.</dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.3</dd></dl>
+</li>
+</ul>
+<a name="getIgnoreSurroundingSpaces()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getIgnoreSurroundingSpaces</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.817">getIgnoreSurroundingSpaces</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.831">getNullString</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.840">getQuoteCharacter</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.849">getQuoteMode</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.858">getRecordSeparator</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.867">getSkipHeaderRecord</a>()</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="getTrailingDelimiter()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTrailingDelimiter</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.877">getTrailingDelimiter</a>()</pre>
+<div class="block">Returns whether to add a trailing delimiter.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>whether to add a trailing delimiter.</dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.3</dd></dl>
+</li>
+</ul>
+<a name="getTrim()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTrim</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.886">getTrim</a>()</pre>
+<div class="block">Returns whether to trim leading and trailing blanks.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>whether to trim leading and trailing blanks.</dd></dl>
+</li>
+</ul>
+<a name="hashCode()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hashCode</h4>
+<pre>public int <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.891">hashCode</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.917">isCommentMarkerSet</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.926">isEscapeCharacterSet</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.935">isNullStringSet</a>()</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 <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.944">isQuoteCharacterSet</a>()</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.961">parse</a>(<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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.978">print</a>(<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="printer()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>printer</h4>
+<pre>public <a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.994">printer</a>()
+ 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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang"><code>System.out</code></a>.
+
+ <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">Returns:</span></dt><dd>a printer to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang"><code>System.out</code></a>.</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><dt><span class="strong">Since:</span></dt>
+ <dd>1.5</dd></dl>
+</li>
+</ul>
+<a name="print(java.io.File, java.nio.charset.Charset)">
+<!-- -->
+</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.1015">print</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> out,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)
+ 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><dd><code>charset</code> - A charset.</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><dt><span class="strong">Since:</span></dt>
+ <dd>1.5</dd></dl>
+</li>
+</ul>
+<a name="print(java.nio.file.Path, java.nio.charset.Charset)">
+<!-- -->
+</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> <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.1036">print</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> out,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)
+ 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><dd><code>charset</code> - A charset.</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><dt><span class="strong">Since:</span></dt>
+ <dd>1.5</dd></dl>
+</li>
+</ul>
+<a name="print(java.lang.Object, java.lang.Appendable, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>print</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.1054">print</a>(<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> value,
+ <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,
+ boolean newRecord)
+ 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 the <code>value</code> as the next value on the line to <code>out</code>. The value will be escaped or encapsulated
+ as needed. Useful when one wants to avoid creating CSVPrinters.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value to output.</dd><dd><code>out</code> - where to print the value.</dd><dd><code>newRecord</code> - if this a new record.</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><dt><span class="strong">Since:</span></dt>
+ <dd>1.4</dd></dl>
+</li>
+</ul>
+<a name="println(java.lang.Appendable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>println</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.1254">println</a>(<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">Outputs the trailing delimiter (if set) followed by the record separator (if set).</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - where to write</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><dt><span class="strong">Since:</span></dt>
+ <dd>1.4</dd></dl>
+</li>
+</ul>
+<a name="printRecord(java.lang.Appendable, java.lang.Object...)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>printRecord</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.1280">printRecord</a>(<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,
+ <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)
+ 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 the given <code>values</code> to <code>out</code> as a single record of delimiter separated values followed by the
+ record separator.
+
+ <p>
+ The values will be quoted if needed. Quotes and new-line characters will be escaped. This method adds the record
+ separator to the output after printing the record, so there is no need to call <a href="../../../../org/apache/commons/csv/CSVFormat.html#println(java.lang.Appendable)"><code>println(Appendable)</code></a>.
+ </p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - where to write.</dd><dd><code>values</code> - values to 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> - If an I/O error occurs.</dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.4</dd></dl>
+</li>
+</ul>
+<a name="toString()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
[... 583 lines stripped ...]