Modified:
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html
==============================================================================
---
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html
(original)
+++
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html
Thu Aug 14 19:48:06 2014
@@ -2,24 +2,38 @@
<!-- NewPage -->
<html lang="de">
<head>
-<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>CSVFormat (Apache Commons CSV 1.0-SNAPSHOT API)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>CSVFormat (Apache Commons CSV 1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css"
title="Style">
+<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CSVFormat (Apache Commons CSV 1.0-SNAPSHOT
API)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CSVFormat (Apache Commons CSV 1.0 API)";
+ }
+ }
+ catch(err) {
}
//-->
+var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static
Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a
name="navbar_top_firstrow">
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -34,15 +48,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li>Prev Class</li>
-<li><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class
in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
+<li>Prev Class</li>
+<li><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class
in org.apache.commons.csv"><span
class="typeNameLink">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>
+<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>
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -60,18 +74,18 @@
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
-<li><a href="#method_summary">Method</a></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><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
-<li><a href="#method_detail">Method</a></li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -126,10 +140,10 @@ implements <a href="http://docs.oracle.c
</pre>
<p>
- The <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class
in org.apache.commons.csv"><code>CSVRecord</code></a> provides static methods
to parse other input types, for example:
+ 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 = CSVFormat.parseFile(file, CSVFormat.EXCEL);</pre>
+ <pre>CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII,
CSVFormat.EXCEL);</pre>
<h2>Defining formats</h2>
@@ -154,11 +168,11 @@ implements <a href="http://docs.oracle.c
</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
+ 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>.
+ <a
href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord-boolean-"><code>withSkipHeaderRecord(boolean)</code></a>
with <code>true</code>.
</p>
<h2>Parsing</h2>
@@ -180,7 +194,7 @@ implements <a href="http://docs.oracle.c
<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:
+ by using <a
href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.String...-"><code>withHeader(String...)</code></a>
with no arguments:
</p>
<pre>
@@ -206,9 +220,12 @@ implements <a href="http://docs.oracle.c
<p>
This class is immutable.
</p></div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Id: CSVFormat.java 1592365 2014-05-04 16:08:56Z britter $</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>
+<dl>
+<dt><span class="simpleTagLabel">Version:</span></dt>
+<dd>$Id: CSVFormat.java 1617076 2014-08-10 09:23:01Z britter $</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a
href="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized
Form</a></dd>
+</dl>
</li>
</ul>
</div>
@@ -217,11 +234,11 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="field_summary">
+<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">
+<table class="memberSummary" 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>
@@ -229,32 +246,32 @@ implements <a href="http://docs.oracle.c
</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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT">DEFAULT</a></span></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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL">EXCEL</a></span></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 <tt>SELECT INTO
OUTFILE</tt> and <tt>LOAD DATA INFILE</tt> operations.</div>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL">MYSQL</a></span></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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180">RFC4180</a></span></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, with quote; leading and trailing
spaces ignored.</div>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#TDF">TDF</a></span></code>
+<div class="block">Tab-delimited format.</div>
</td>
</tr>
</table>
@@ -262,233 +279,251 @@ implements <a href="http://docs.oracle.c
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="method_summary">
+<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>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span
class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a
href="javascript:show(1);">Static Methods</a></span><span
class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </span></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">
+<tr id="i0" 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/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a> obj)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#equals-java.lang.Object-">equals</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i1" class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a>... values)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#format-java.lang.Object...-">format</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getAllowMissingColumnNames--">getAllowMissingColumnNames</a></span>()</code>
+<div class="block">Specifies whether missing column names are allowed when
parsing the header line.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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#getCommentStart()">getCommentStart</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getCommentMarker--">getCommentMarker</a></span>()</code>
<div class="block">Returns the character marking the start of a line
comment.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i4" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getDelimiter--">getDelimiter</a></span>()</code>
<div class="block">Returns the character delimiting the values (typically ';',
',' or '\t').</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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#getEscape()">getEscape</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getEscapeCharacter--">getEscapeCharacter</a></span>()</code>
<div class="block">Returns the escape character.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getHeader--">getHeader</a></span>()</code>
<div class="block">Returns a copy of the header array.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i7" class="rowColor">
<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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreEmptyLines--">getIgnoreEmptyLines</a></span>()</code>
<div class="block">Specifies whether empty lines between records are ignored
when parsing input.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i8" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreSurroundingSpaces--">getIgnoreSurroundingSpaces</a></span>()</code>
<div class="block">Specifies whether spaces around values are ignored when
parsing input.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getNullString--">getNullString</a></span>()</code>
<div class="block">Gets the String to convert to and from
<code>null</code>.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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#getQuoteChar()">getQuoteChar</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteCharacter--">getQuoteCharacter</a></span>()</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/Quote.html" title="enum in
org.apache.commons.csv">Quote</a></code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getQuotePolicy()">getQuotePolicy</a></strong>()</code>
+<tr id="i11" 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><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteMode--">getQuoteMode</a></span>()</code>
<div class="block">Returns the quote policy output fields.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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 line separator delimiting output records.</div>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getRecordSeparator--">getRecordSeparator</a></span>()</code>
+<div class="block">Returns the record separator delimiting output
records.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i13" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#getSkipHeaderRecord--">getSkipHeaderRecord</a></span>()</code>
<div class="block">Returns whether to skip the header record.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i14" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isCommentingEnabled()">isCommentingEnabled</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isCommentMarkerSet--">isCommentMarkerSet</a></span>()</code>
<div class="block">Specifies whether comments are supported by this
format.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isEscaping()">isEscaping</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isEscapeCharacterSet--">isEscapeCharacterSet</a></span>()</code>
<div class="block">Returns whether escape are being processed.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isNullHandling()">isNullHandling</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isNullStringSet--">isNullStringSet</a></span>()</code>
<div class="block">Returns whether a nullString has been defined.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isQuoting()">isQuoting</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#isQuoteCharacterSet--">isQuoteCharacterSet</a></span>()</code>
<div class="block">Returns whether a quoteChar has been defined.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i19" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#newFormat-char-">newFormat</a></span>(char delimiter)</code>
<div class="block">Creates a new CSV format with the specified delimiter.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i20" 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/6/docs/api/java/io/Reader.html?is-external=true";
title="class or interface in java.io">Reader</a> in)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#parse-java.io.Reader-">parse</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i21" 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><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.lang.Appendable-">print</a></span>(<a
href="http://docs.oracle.com/javase/6/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 id="i22" class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#toString--">toString</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i23" 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><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames-boolean-">withAllowMissingColumnNames</a></span>(boolean allowMissingColumnNames)</code>
+<div class="block">Sets the missing column names behavior of the format.</div>
+</td>
+</tr>
+<tr id="i24" 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#withCommentStart(char)">withCommentStart</a></strong>(char commentStart)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker-char-">withCommentMarker</a></span>(char commentMarker)</code>
<div class="block">Sets the comment start marker of the format to the
specified character.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i25" 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#withCommentStart(java.lang.Character)">withCommentStart</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true";
title="class or interface in java.lang">Character</a> commentStart)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker-java.lang.Character-">withCommentMarker</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i26" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withDelimiter-char-">withDelimiter</a></span>(char delimiter)</code>
<div class="block">Sets the delimiter of the format to the specified
character.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i27" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape-char-">withEscape</a></span>(char escape)</code>
<div class="block">Sets the escape character of the format to the specified
character.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i28" 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/6/docs/api/java/lang/Character.html?is-external=true";
title="class or interface in java.lang">Character</a> escape)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape-java.lang.Character-">withEscape</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i29" 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/6/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>... header)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.String...-">withHeader</a></span>(<a
href="http://docs.oracle.com/javase/6/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">
+<tr id="i30" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines-boolean-">withIgnoreEmptyLines</a></span>(boolean ignoreEmptyLines)</code>
<div class="block">Sets the empty line skipping behavior of the format.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i31" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces-boolean-">withIgnoreSurroundingSpaces</a></span>(boolean ignoreSurroundingSpaces)</code>
<div class="block">Sets the trimming behavior of the format.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i32" 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/6/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> nullString)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withNullString-java.lang.String-">withNullString</a></span>(<a
href="http://docs.oracle.com/javase/6/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="altColor">
+<tr id="i33" 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#withQuoteChar(char)">withQuoteChar</a></strong>(char quoteChar)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote-char-">withQuote</a></span>(char quoteChar)</code>
<div class="block">Sets the quoteChar of the format to the specified
character.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i34" 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#withQuoteChar(java.lang.Character)">withQuoteChar</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true";
title="class or interface in java.lang">Character</a> quoteChar)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote-java.lang.Character-">withQuote</a></span>(<a
href="http://docs.oracle.com/javase/6/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="altColor">
+<tr id="i35" 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#withQuotePolicy(org.apache.commons.csv.Quote)">withQuotePolicy</a></strong>(<a
href="../../../../org/apache/commons/csv/Quote.html" title="enum in
org.apache.commons.csv">Quote</a> quotePolicy)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withQuoteMode-org.apache.commons.csv.QuoteMode-">withQuoteMode</a></span>(<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="rowColor">
+<tr id="i36" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator-char-">withRecordSeparator</a></span>(char recordSeparator)</code>
<div class="block">Sets the record separator of the format to the specified
character.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i37" 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/6/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> recordSeparator)</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator-java.lang.String-">withRecordSeparator</a></span>(<a
href="http://docs.oracle.com/javase/6/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="rowColor">
+<tr id="i38" 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>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord-boolean-">withSkipHeaderRecord</a></span>(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">
+<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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</a></code></li>
+<code><a
href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-";
title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -500,7 +535,7 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="field_detail">
+<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
@@ -510,17 +545,17 @@ implements <a href="http://docs.oracle.c
<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.174">DEFAULT</a></pre>
+<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.175">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.
- <h3>RFC 4180:</h3>
- <ul>
- <li>withDelimiter(',')</li>
- <li>withQuoteChar('"')</li>
- <li>withRecordSeparator(CRLF)</li>
- </ul>
- <h3>Additional:</h3>
+
+ <p>
+ Settings are:
+ </p>
<ul>
- <li>withIgnoreEmptyLines(true)</li>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withRecordSeparator("\r\n")</li>
+ <li>withIgnoreEmptyLines(true)</li>
</ul></div>
</li>
</ul>
@@ -530,13 +565,17 @@ implements <a href="http://docs.oracle.c
<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.186">RFC4180</a></pre>
+<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.191">RFC4180</a></pre>
<div class="block">Comma separated format as defined by <a
href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>.
- <h3>RFC 4180:</h3>
+
+ <p>
+ Settings are:
+ </p>
<ul>
- <li>withDelimiter(',')</li>
- <li>withQuoteChar('"')</li>
- <li>withRecordSeparator(CRLF)</li>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withRecordSeparator("\r\n")</li>
+ <li>withIgnoreEmptyLines(false)</li>
</ul></div>
</li>
</ul>
@@ -546,7 +585,7 @@ implements <a href="http://docs.oracle.c
<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.210">EXCEL</a></pre>
+<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.218">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.
@@ -555,18 +594,21 @@ implements <a href="http://docs.oracle.c
</p>
<pre>
- CSVFormat fmt = CSVFormat.newBuilder(EXCEL).withDelimiter(';');
+ CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');
</pre>
<p>
Settings are:
</p>
<ul>
- <li>withDelimiter(',')</li>
- <li>withQuoteChar('"')</li>
- <li>withRecordSeparator(CRLF)</li>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withRecordSeparator("\r\n")</li>
+ <li>withIgnoreEmptyLines(false)</li>
</ul>
- Note: this is currently the same as RFC4180</div>
+ <p>
+ Note: this is currently the same as <a
href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a>.
+ </p></div>
</li>
</ul>
<a name="TDF">
@@ -575,8 +617,18 @@ implements <a href="http://docs.oracle.c
<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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.213">TDF</a></pre>
-<div class="block">Tab-delimited format, with quote; leading and trailing
spaces ignored.</div>
+<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.233">TDF</a></pre>
+<div class="block">Tab-delimited format.
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter('\t')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withRecordSeparator("\r\n")</li>
+ <li>withIgnoreSurroundingSpaces(true)</li>
+ </ul></div>
</li>
</ul>
<a name="MYSQL">
@@ -585,136 +637,203 @@ implements <a href="http://docs.oracle.c
<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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.226">MYSQL</a></pre>
-<div class="block">Default MySQL format used by the <tt>SELECT INTO
OUTFILE</tt> and <tt>LOAD DATA INFILE</tt> operations. This is
- a tab-delimited format with a LF character as the line separator. Values are
not quoted and special characters
- are escaped with '\'.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><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>
+<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.259">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 '\'.
+ </p>
+
+ <p>
+ Settings are:
+ </p>
+ <ul>
+ <li>withDelimiter('\t')</li>
+ <li>withQuoteChar(null)</li>
+ <li>withRecordSeparator('\n')</li>
+ <li>withIgnoreEmptyLines(false)</li>
+ <li>withEscape('\\')</li>
+ </ul></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><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">
+<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="newFormat(char)">
+<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.266">newFormat</a>(char delimiter)</pre>
-<div class="block">Creates a new CSV format with the specified delimiter.</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/6/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></dl>
+<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.308">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="paramLabel">Parameters:</span></dt>
+<dd><code>delimiter</code> - the char used for value separation, must not be a
line break character</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a new CSV format.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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="seeLabel">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="equals(java.lang.Object)">
+<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.319">equals</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a> obj)</pre>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.375">equals</a>(<a
href="http://docs.oracle.com/javase/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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/6/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 name="format-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.384">format</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a>... values)</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.450">format</a>(<a
href="http://docs.oracle.com/javase/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - the values to format</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the formatted values</dd>
+</dl>
</li>
</ul>
-<a name="getCommentStart()">
+<a name="getCommentMarker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getCommentStart</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.400">getCommentStart</a>()</pre>
+<h4>getCommentMarker</h4>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.466">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the comment start marker, may be <code>null</code></dd>
+</dl>
</li>
</ul>
-<a name="getDelimiter()">
+<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.409">getDelimiter</a>()</pre>
+<pre>public char <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.475">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the delimiter character</dd>
+</dl>
</li>
</ul>
-<a name="getEscape()">
+<a name="getEscapeCharacter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getEscape</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.418">getEscape</a>()</pre>
+<h4>getEscapeCharacter</h4>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.484">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the escape character, may be <code>null</code></dd>
+</dl>
</li>
</ul>
-<a name="getHeader()">
+<a name="getHeader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.427">getHeader</a>()</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.493">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</dd></dl>
+<dl>
+<dt><span class="returnLabel">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="getIgnoreEmptyLines()">
+<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.503">getAllowMissingColumnNames</a>()</pre>
+<div class="block">Specifies whether missing column names are allowed when
parsing the header line.</div>
+<dl>
+<dt><span class="returnLabel">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/6/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 <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.437">getIgnoreEmptyLines</a>()</pre>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.513">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><tt>true</tt> if empty
lines between records are ignored, <tt>false</tt> if they are turned into empty
- records.</dd></dl>
+<dl>
+<dt><span class="returnLabel">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 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.447">getIgnoreSurroundingSpaces</a>()</pre>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.523">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><tt>true</tt> if spaces
around values are ignored, <tt>false</tt> if they are treated as part of the
- value.</dd></dl>
+<dl>
+<dt><span class="returnLabel">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 name="getNullString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNullString</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.464">getNullString</a>()</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.540">getNullString</a>()</pre>
<div class="block">Gets the String to convert to and from <code>null</code>.
<ul>
<li>
@@ -724,225 +843,299 @@ implements <a href="http://docs.oracle.c
<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>
+<dl>
+<dt><span class="returnLabel">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="getQuoteChar()">
+<a name="getQuoteCharacter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getQuoteChar</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.473">getQuoteChar</a>()</pre>
+<h4>getQuoteCharacter</h4>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.549">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the quoteChar character, may be <code>null</code></dd>
+</dl>
</li>
</ul>
-<a name="getQuotePolicy()">
+<a name="getQuoteMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getQuotePolicy</h4>
-<pre>public <a href="../../../../org/apache/commons/csv/Quote.html"
title="enum in org.apache.commons.csv">Quote</a> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.482">getQuotePolicy</a>()</pre>
+<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.558">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the quote policy</dd>
+</dl>
</li>
</ul>
-<a name="getRecordSeparator()">
+<a name="getRecordSeparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordSeparator</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.491">getRecordSeparator</a>()</pre>
-<div class="block">Returns the line separator delimiting output records.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the line
separator</dd></dl>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.567">getRecordSeparator</a>()</pre>
+<div class="block">Returns the record separator delimiting output
records.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the record separator</dd>
+</dl>
</li>
</ul>
-<a name="getSkipHeaderRecord()">
+<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.500">getSkipHeaderRecord</a>()</pre>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.576">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether to skip the header record.</dd>
+</dl>
</li>
</ul>
-<a name="hashCode()">
+<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.505">hashCode</a>()</pre>
+<pre>public int <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.581">hashCode</a>()</pre>
<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a
href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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/6/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="isCommentingEnabled()">
+<a name="isCommentMarkerSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>isCommentingEnabled</h4>
-<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.529">isCommentingEnabled</a>()</pre>
+<h4>isCommentMarkerSet</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.607">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><tt>true</tt> is comments
are supported, <tt>false</tt> otherwise</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> is comments are supported, <code>false</code>
otherwise</dd>
+</dl>
</li>
</ul>
-<a name="isEscaping()">
+<a name="isEscapeCharacterSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>isEscaping</h4>
-<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.538">isEscaping</a>()</pre>
+<h4>isEscapeCharacterSet</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.616">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if escapes are processed</dd>
+</dl>
</li>
</ul>
-<a name="isNullHandling()">
+<a name="isNullStringSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>isNullHandling</h4>
-<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.547">isNullHandling</a>()</pre>
+<h4>isNullStringSet</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.625">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if a nullString is defined</dd>
+</dl>
</li>
</ul>
-<a name="isQuoting()">
+<a name="isQuoteCharacterSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>isQuoting</h4>
-<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.556">isQuoting</a>()</pre>
+<h4>isQuoteCharacterSet</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.634">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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if a quoteChar is defined</dd>
+</dl>
</li>
</ul>
-<a name="parse(java.io.Reader)">
+<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.573">parse</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true";
title="class or interface in java.io">Reader</a> in)
+<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.651">parse</a>(<a
href="http://docs.oracle.com/javase/6/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/6/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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>in</code> - the input stream</dd>
+<dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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.668">print</a>(<a
href="http://docs.oracle.com/javase/6/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/6/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="paramLabel">Parameters:</span></dt>
+<dd><code>out</code> - the output</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a printer to an output</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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 name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/6/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.578">toString</a>()</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/6/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.673">toString</a>()</pre>
<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a
href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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/6/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="withCommentStart(char)">
+<a name="withCommentMarker-char-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>withCommentStart</h4>
-<pre>public <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.670">withCommentStart</a>(char commentStart)</pre>
+<h4>withCommentMarker</h4>
+<pre>public <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.757">withCommentMarker</a>(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>commentStart</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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>commentMarker</code> - the comment start marker</dd>
+<dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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="withCommentStart(java.lang.Character)">
+<a name="withCommentMarker-java.lang.Character-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>withCommentStart</h4>
-<pre>public <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.685">withCommentStart</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true";
title="class or interface in java.lang">Character</a> commentStart)</pre>
+<h4>withCommentMarker</h4>
+<pre>public <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.772">withCommentMarker</a>(<a
href="http://docs.oracle.com/javase/6/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>commentStart</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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>commentMarker</code> - the comment start marker, use
<code>null</code> to disable</dd>
+<dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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 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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.702">withDelimiter</a>(char delimiter)</pre>
+<pre>public <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.790">withDelimiter</a>(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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>delimiter</code> - the delimiter character</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A new CSVFormat that is equal to this with the specified character as
delimiter</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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 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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.719">withEscape</a>(char escape)</pre>
+<pre>public <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.808">withEscape</a>(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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>escape</code> - the escape character</dd>
+<dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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 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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.732">withEscape</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true";
title="class or interface in java.lang">Character</a> escape)</pre>
+<pre>public <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.821">withEscape</a>(<a
href="http://docs.oracle.com/javase/6/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/6/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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>escape</code> - the escape character, use <code>null</code> to
disable</dd>
+<dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/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 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> <a
href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.757">withHeader</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>... header)</pre>
+<pre>public <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.847">withHeader</a>(<a
href="http://docs.oracle.com/javase/6/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>
@@ -952,43 +1145,74 @@ implements <a href="http://docs.oracle.c
<pre>
CSVFormat format = aformat.withHeader("name", "email",
"phone");</pre></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> -
the header, <tt>null</tt> 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>
+<dl>
+<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
+<dd>A new CSVFormat that is equal to this but with the specified header</dd>
+<dt><span class="seeLabel">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="withIgnoreEmptyLines(boolean)">
+<a name="withAllowMissingColumnNames-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>withAllowMissingColumnNames</h4>
[... 282 lines stripped ...]
