You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2014/08/14 21:48:09 UTC
svn commit: r919363 [5/44] - in
/websites/production/commons/content/proper/commons-csv: ./ apidocs/
apidocs/org/apache/commons/csv/ apidocs/org/apache/commons/csv/class-use/
apidocs/resources/ apidocs/src-html/org/apache/commons/csv/ jacoco/
jacoco/.r...
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.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>CSVPrinter (Apache Commons CSV 1.0-SNAPSHOT API)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>CSVPrinter (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="CSVPrinter (Apache Commons CSV 1.0-SNAPSHOT API)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CSVPrinter (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};
+var tabs = {65535:["t0","All 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><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVRecord.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/CSVPrinter.html" target="_top">Frames</a></li>
-<li><a href="CSVPrinter.html" target="_top">No Frames</a></li>
+<li><a href="CSVPrinter.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"><!--
@@ -61,17 +75,17 @@
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
-<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
-<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li><a href="#constructor.detail">Constr</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 ========= -->
@@ -102,8 +116,10 @@
extends <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>
implements <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre>
<div class="block">Prints values in a CSV format.</div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Id: CSVPrinter.java 1592365 2014-05-04 16:08:56Z britter $</dd></dl>
+<dl>
+<dt><span class="simpleTagLabel">Version:</span></dt>
+<dd>$Id: CSVPrinter.java 1617076 2014-08-10 09:23:01Z britter $</dd>
+</dl>
</li>
</ul>
</div>
@@ -112,18 +128,18 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_summary">
+<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#CSVPrinter(java.lang.Appendable, org.apache.commons.csv.CSVFormat)">CSVPrinter</a></strong>(<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,
- <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</code>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#CSVPrinter-java.lang.Appendable-org.apache.commons.csv.CSVFormat-">CSVPrinter</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,
+ <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</code>
<div class="block">Creates a printer that will print values to the given stream following the CSVFormat.</div>
</td>
</tr>
@@ -132,87 +148,87 @@ 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="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>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#close()">close</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#close--">close</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#flush()">flush</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#flush--">flush</a></span>()</code>
<div class="block">Flushes the underlying stream.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#getOut()">getOut</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#getOut--">getOut</a></span>()</code>
<div class="block">Gets the target Appendable.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#print(java.lang.Object)">print</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> value)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#print-java.lang.Object-">print</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> value)</code>
<div class="block">Prints the string as the next value on the line.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printComment(java.lang.String)">printComment</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> comment)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printComment-java.lang.String-">printComment</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> comment)</code>
<div class="block">Prints a comment on a new line among the delimiter separated values.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#println()">println</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#println--">println</a></span>()</code>
<div class="block">Outputs the record separator.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord(java.lang.Iterable)">printRecord</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)</code>
-<div class="block">Prints a single line of delimiter separated values.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Iterable-">printRecord</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)</code>
+<div class="block">Prints the given values a single record of delimiter separated values followed by the record separator.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord(java.lang.Object...)">printRecord</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>
-<div class="block">Prints a single line of delimiter separated values.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Object...-">printRecord</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">Prints the given values a single record of delimiter separated values followed by the record separator.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords(java.lang.Iterable)">printRecords</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)</code>
-<div class="block">Prints all the objects in the given collection.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.lang.Iterable-">printRecords</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)</code>
+<div class="block">Prints all the objects in the given collection handling nested collections/arrays as records.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords(java.lang.Object[])">printRecords</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>
-<div class="block">Prints all the objects in the given array.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.lang.Object...-">printRecords</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">Prints all the objects in the given array handling nested collections/arrays as records.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords(java.sql.ResultSet)">printRecords</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.sql.ResultSet-">printRecords</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)</code>
<div class="block">Prints all the objects in the given JDBC result set.</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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-external=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#equals-java.lang.Object-" title="class or interface in java.lang">equals</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#hashCode--" title="class or interface in java.lang">hashCode</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#toString--" title="class or interface in java.lang">toString</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-external=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>
@@ -224,90 +240,101 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_detail">
+<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
-<a name="CSVPrinter(java.lang.Appendable, org.apache.commons.csv.CSVFormat)">
+<a name="CSVPrinter-java.lang.Appendable-org.apache.commons.csv.CSVFormat-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CSVPrinter</h4>
-<pre>public <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.59">CSVPrinter</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,
- <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</pre>
+<pre>public <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.61">CSVPrinter</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,
+ <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)
+ 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">Creates a printer that will print values to the given stream following the CSVFormat.
<p>
- Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats
- (encapsulation and escaping with a different character) are not supported.
+ Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats (encapsulation
+ and escaping with a different character) are not supported.
</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - stream to which to print. Must not be null.</dd><dd><code>format</code> - the CSV format. Must not be null.</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 parameters of the format are inconsistent or if either out or format are null.</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>out</code> - stream to which to print. Must not be null.</dd>
+<dd><code>format</code> - the CSV format. Must not be null.</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>
+<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 parameters of the format are inconsistent or if either out or format are null.</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="close()">
+<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.72">close</a>()
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.78">close</a>()
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>
<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></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></dd></dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></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></dd>
+</dl>
</li>
</ul>
-<a name="flush()">
+<a name="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.84">flush</a>()
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.90">flush</a>()
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">Flushes the underlying stream.</div>
<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Flushable.html?is-external=true#flush()" title="class or interface in java.io">flush</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></code></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>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Flushable.html?is-external=true#flush--" title="class or interface in java.io">flush</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></code></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.Object)">
+<a name="print-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.98">print</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> value)
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.104">print</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> value)
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 the string as the next value on the line. The value will be escaped or encapsulated as needed.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value to be output.</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>value</code> - value to be 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> - If an I/O error occurs</dd>
+</dl>
</li>
</ul>
-<a name="printComment(java.lang.String)">
+<a name="printComment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printComment</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.293">printComment</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> comment)
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.297">printComment</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> comment)
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 a comment on a new line among the delimiter separated values.
@@ -317,108 +344,185 @@ implements <a href="http://docs.oracle.c
</p>
If comments are disabled in the current CSV format this method does nothing.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comment</code> - the comment to output</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>comment</code> - the comment to 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> - If an I/O error occurs</dd>
+</dl>
</li>
</ul>
-<a name="println()">
+<a name="println--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.329">println</a>()
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.333">println</a>()
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">Outputs the record separator.</div>
-<dl><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="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="printRecord(java.lang.Iterable)">
+<a name="printRecord-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printRecord</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.346">printRecord</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.354">printRecord</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)
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 a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine
- characters will be escaped.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to output.</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>
+<div class="block">Prints the given values a single record of delimiter separated values followed by the record separator.
+
+ <p>
+ The values will be quoted if needed. Quotes and newLine 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/CSVPrinter.html#println--"><code>println()</code></a>.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - values to 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> - If an I/O error occurs</dd>
+</dl>
</li>
</ul>
-<a name="printRecord(java.lang.Object...)">
+<a name="printRecord-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printRecord</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.362">printRecord</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>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.374">printRecord</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)
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 a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine
- characters will be escaped.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to output.</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>
+<div class="block">Prints the given values a single record of delimiter separated values followed by the record separator.
+
+ <p>
+ The values will be quoted if needed. Quotes and newLine 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/CSVPrinter.html#println--"><code>println()</code></a>.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - values to 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> - If an I/O error occurs</dd>
+</dl>
</li>
</ul>
-<a name="printRecords(java.lang.Iterable)">
+<a name="printRecords-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.377">printRecords</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.412">printRecords</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> values)
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 all the objects in the given collection.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the values to print.</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>
+<div class="block">Prints all the objects in the given collection handling nested collections/arrays as records.
+
+ <p>If the given collection only contains simple objects, this method will print a single record like
+ <a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Iterable-"><code>printRecord(Iterable)</code></a>. If the given collections contains nested collections/arrays those nested elements
+ will each be printed as records using <a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Object...-"><code>printRecord(Object...)</code></a>.</p>
+
+ <p>Given the following data structure:</p>
+ <pre>
+ <code>
+ List<String[]> data = ...
+ data.add(new String[]{ "A", "B", "C" });
+ data.add(new String[]{ "1", "2", "3" });
+ data.add(new String[]{ "A1", "B2", "C3" });
+ </code>
+ </pre>
+
+ <p>Calling this method will print:</p>
+ <pre>
+ <code>
+ A, B, C
+ 1, 2, 3
+ A1, B2, C3
+ </code>
+ </pre></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - the values to print.</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="printRecords(java.lang.Object[])">
+<a name="printRecords-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.397">printRecords</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>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.455">printRecords</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)
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 all the objects in the given array.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the values to print.</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>
+<div class="block">Prints all the objects in the given array handling nested collections/arrays as records.
+
+ <p>If the given array only contains simple objects, this method will print a single record like
+ <a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Object...-"><code>printRecord(Object...)</code></a>. If the given collections contains nested collections/arrays those nested
+ elements will each be printed as records using <a href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Object...-"><code>printRecord(Object...)</code></a>.</p>
+
+ <p>Given the following data structure:</p>
+ <pre>
+ <code>
+ String[][] data = new String[3][]
+ data[0] = String[]{ "A", "B", "C" };
+ data[1] = new String[]{ "1", "2", "3" };
+ data[2] = new String[]{ "A1", "B2", "C3" };
+ </code>
+ </pre>
+
+ <p>Calling this method will print:</p>
+ <pre>
+ <code>
+ A, B, C
+ 1, 2, 3
+ A1, B2, C3
+ </code>
+ </pre></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - the values to print.</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="printRecords(java.sql.ResultSet)">
+<a name="printRecords-java.sql.ResultSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.418">printRecords</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)
+<pre>public void <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.476">printRecords</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a>,
<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 all the objects in the given JDBC result set.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resultSet</code> - result set
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>resultSet</code> - result set
the values to print.</dd>
-<dt><span class="strong">Throws:</span></dt>
+<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>
-<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - if a database access error occurs</dd></dl>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - if a database access error occurs</dd>
+</dl>
</li>
</ul>
-<a name="getOut()">
+<a name="getOut--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOut</h4>
-<pre>public <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> <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.433">getOut</a>()</pre>
+<pre>public <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> <a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.491">getOut</a>()</pre>
<div class="block">Gets the target Appendable.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the target Appendable.</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the target Appendable.</dd>
+</dl>
</li>
</ul>
</li>
@@ -429,9 +533,11 @@ implements <a href="http://docs.oracle.c
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -446,15 +552,15 @@ implements <a href="http://docs.oracle.c
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVRecord.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/CSVPrinter.html" target="_top">Frames</a></li>
-<li><a href="CSVPrinter.html" target="_top">No Frames</a></li>
+<li><a href="CSVPrinter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -473,17 +579,17 @@ implements <a href="http://docs.oracle.c
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
-<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
-<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.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>CSVRecord (Apache Commons CSV 1.0-SNAPSHOT API)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>CSVRecord (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="CSVRecord (Apache Commons CSV 1.0-SNAPSHOT API)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CSVRecord (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};
+var tabs = {65535:["t0","All 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><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum 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/CSVRecord.html" target="_top">Frames</a></li>
-<li><a href="CSVRecord.html" target="_top">No Frames</a></li>
+<li><a href="CSVRecord.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"><!--
@@ -62,16 +76,16 @@
<li>Nested | </li>
<li>Field | </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>Field | </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 ========= -->
@@ -102,9 +116,12 @@
extends <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>
implements <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</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>></pre>
<div class="block">A CSV record parsed from a CSV file.</div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Id$</dd>
-<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.commons.csv.CSVRecord">Serialized Form</a></dd></dl>
+<dl>
+<dt><span class="simpleTagLabel">Version:</span></dt>
+<dd>$Id$</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../serialized-form.html#org.apache.commons.csv.CSVRecord">Serialized Form</a></dd>
+</dl>
</li>
</ul>
</div>
@@ -113,93 +130,102 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ========== 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="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><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/CSVRecord.html#get(java.lang.Enum)">get</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><?> e)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#get-java.lang.Enum-">get</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><?> e)</code>
<div class="block">Returns a value by <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang"><code>Enum</code></a>.</div>
</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/CSVRecord.html#get(int)">get</a></strong>(int i)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#get-int-">get</a></span>(int i)</code>
<div class="block">Returns a value by index.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i2" 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/CSVRecord.html#get(java.lang.String)">get</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> name)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#get-java.lang.String-">get</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> name)</code>
<div class="block">Returns a value by name.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i3" 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/CSVRecord.html#getComment()">getComment</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#getComment--">getComment</a></span>()</code>
<div class="block">Returns the comment for this record, if any.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#getRecordNumber()">getRecordNumber</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#getRecordNumber--">getRecordNumber</a></span>()</code>
<div class="block">Returns the number of this record in the parsed CSV file.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#isConsistent()">isConsistent</a></strong>()</code>
-<div class="block">Returns true if this record is consistent, false if not.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#isConsistent--">isConsistent</a></span>()</code>
+<div class="block">Tells whether the record size matches the header size.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#isMapped(java.lang.String)">isMapped</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> name)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#isMapped-java.lang.String-">isMapped</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> name)</code>
<div class="block">Checks whether a given column is mapped, i.e. its name has been defined to the parser.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#isSet(java.lang.String)">isSet</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> name)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#isSet-java.lang.String-">isSet</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> name)</code>
<div class="block">Checks whether a given columns is mapped and has a value.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</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>></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#iterator()">iterator</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns an iterator over the values of this record.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVRecord.html#size()">size</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#size--">size</a></span>()</code>
<div class="block">Returns the number of values in this record.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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/CSVRecord.html#toMap()">toMap</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#toMap--">toMap</a></span>()</code>
<div class="block">Copies this record into a new Map.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i11" 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/CSVRecord.html#toString()">toString</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVRecord.html#toString--">toString</a></span>()</code>
+<div class="block">Returns a string representation of the contents of this 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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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-external=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#equals-java.lang.Object-" title="class or interface in java.lang">equals</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#hashCode--" title="class or interface in java.lang">hashCode</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-external=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>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
+<!-- -->
+</a>
+<h3>Methods inherited from interface java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
+<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</li>
</ul>
@@ -211,11 +237,11 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ============ 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="get(java.lang.Enum)">
+<a name="get-java.lang.Enum-">
<!-- -->
</a>
<ul class="blockList">
@@ -223,11 +249,15 @@ implements <a href="http://docs.oracle.c
<h4>get</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/CSVRecord.html#line.66">get</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><?> e)</pre>
<div class="block">Returns a value by <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang"><code>Enum</code></a>.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - an enum</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the String at the given enum String</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>e</code> - an enum</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the String at the given enum String</dd>
+</dl>
</li>
</ul>
-<a name="get(int)">
+<a name="get-int-">
<!-- -->
</a>
<ul class="blockList">
@@ -235,11 +265,15 @@ implements <a href="http://docs.oracle.c
<h4>get</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/CSVRecord.html#line.77">get</a>(int i)</pre>
<div class="block">Returns a value by index.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - a column index (0-based)</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the String at the given index</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>i</code> - a column index (0-based)</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the String at the given index</dd>
+</dl>
</li>
</ul>
-<a name="get(java.lang.String)">
+<a name="get-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
@@ -247,15 +281,21 @@ implements <a href="http://docs.oracle.c
<h4>get</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/CSVRecord.html#line.94">get</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> name)</pre>
<div class="block">Returns a value by name.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the column to be retrieved.</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the column value, maybe null depending on <a href="../../../../org/apache/commons/csv/CSVFormat.html#getNullString()"><code>CSVFormat.getNullString()</code></a>.</dd>
-<dt><span class="strong">Throws:</span></dt>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the column to be retrieved.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the column value, maybe null depending on <a href="../../../../org/apache/commons/csv/CSVFormat.html#getNullString--"><code>CSVFormat.getNullString()</code></a>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if no header mapping was provided</dd>
-<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 <code>name</code> is not mapped or if the record is inconsistent</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/csv/CSVRecord.html#isConsistent()"><code>isConsistent()</code></a>,
-<a href="../../../../org/apache/commons/csv/CSVFormat.html#withNullString(java.lang.String)"><code>CSVFormat.withNullString(String)</code></a></dd></dl>
+<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 <code>name</code> is not mapped or if the record is inconsistent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/commons/csv/CSVRecord.html#isConsistent--"><code>isConsistent()</code></a>,
+<a href="../../../../org/apache/commons/csv/CSVFormat.html#withNullString-java.lang.String-"><code>CSVFormat.withNullString(String)</code></a></dd>
+</dl>
</li>
</ul>
-<a name="getComment()">
+<a name="getComment--">
<!-- -->
</a>
<ul class="blockList">
@@ -263,103 +303,143 @@ implements <a href="http://docs.oracle.c
<h4>getComment</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/CSVRecord.html#line.119">getComment</a>()</pre>
<div class="block">Returns the comment for this record, if any.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the comment for this record, or null if no comment for this
- record is available.</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the comment for this record, or null if no comment for this
+ record is available.</dd>
+</dl>
</li>
</ul>
-<a name="getRecordNumber()">
+<a name="getRecordNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordNumber</h4>
-<pre>public long <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.128">getRecordNumber</a>()</pre>
-<div class="block">Returns the number of this record in the parsed CSV file.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the number of this record.</dd></dl>
+<pre>public long <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.134">getRecordNumber</a>()</pre>
+<div class="block">Returns the number of this record in the parsed CSV file.
+
+ <p>
+ <strong>ATTENTION:</strong> If your CSV input has multi-line values, the returned number does not correspond to
+ the current line number of the parser that created this record.
+ </p></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the number of this record.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/commons/csv/CSVParser.html#getCurrentLineNumber--"><code>CSVParser.getCurrentLineNumber()</code></a></dd>
+</dl>
</li>
</ul>
-<a name="isConsistent()">
+<a name="isConsistent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConsistent</h4>
-<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.138">isConsistent</a>()</pre>
-<div class="block">Returns true if this record is consistent, false if not. Currently, the only check is matching the record size to
- the header size. Some programs can export files that fails this test but still produce parsable files.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true of this record is valid, false if not</dd></dl>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.148">isConsistent</a>()</pre>
+<div class="block">Tells whether the record size matches the header size.
+
+ <p>
+ Returns true if the sizes for this record match and false if not. Some programs can export files that fail this
+ test but still produce parsable files.
+ </p></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true of this record is valid, false if not</dd>
+</dl>
</li>
</ul>
-<a name="isMapped(java.lang.String)">
+<a name="isMapped-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMapped</h4>
-<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.149">isMapped</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> name)</pre>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.159">isMapped</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> name)</pre>
<div class="block">Checks whether a given column is mapped, i.e. its name has been defined to the parser.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the column to be retrieved.</dd>
-<dt><span class="strong">Returns:</span></dt><dd>whether a given column is mapped.</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the column to be retrieved.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether a given column is mapped.</dd>
+</dl>
</li>
</ul>
-<a name="isSet(java.lang.String)">
+<a name="isSet-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSet</h4>
-<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.160">isSet</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> name)</pre>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.170">isSet</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> name)</pre>
<div class="block">Checks whether a given columns is mapped and has a value.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the column to be retrieved.</dd>
-<dt><span class="strong">Returns:</span></dt><dd>whether a given columns is mapped and has a value</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the column to be retrieved.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether a given columns is mapped and has a value</dd>
+</dl>
</li>
</ul>
-<a name="iterator()">
+<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
-<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</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>> <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.169">iterator</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</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>> <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.179">iterator</a>()</pre>
<div class="block">Returns an iterator over the values of this record.</div>
<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</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>></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>an iterator over the values of this record.</dd></dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</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>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an iterator over the values of this record.</dd>
+</dl>
</li>
</ul>
-<a name="size()">
+<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
-<pre>public int <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.194">size</a>()</pre>
+<pre>public int <a href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.207">size</a>()</pre>
<div class="block">Returns the number of values in this record.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the number of values.</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the number of values.</dd>
+</dl>
</li>
</ul>
-<a name="toMap()">
+<a name="toMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMap</h4>
-<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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/CSVRecord.html#line.213">toMap</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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/CSVRecord.html#line.226">toMap</a>()</pre>
<div class="block">Copies this record into a new Map. The new map is not connect</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>A new Map. The map is empty if the record has no headers.</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A new Map. The map is empty if the record has no headers.</dd>
+</dl>
</li>
</ul>
-<a name="toString()">
+<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<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/CSVRecord.html#line.218">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/CSVRecord.html#line.237">toString</a>()</pre>
+<div class="block">Returns a string representation of the contents of this record. The result is constructed by passing the internal
+ values array to <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Arrays.html?is-external=true#toString-java.lang.Object:A-" title="class or interface in java.util"><code>Arrays.toString(Object[])</code></a>.</div>
<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>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a String representation of this record.</dd>
</dl>
</li>
</ul>
@@ -371,9 +451,11 @@ implements <a href="http://docs.oracle.c
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -388,15 +470,15 @@ implements <a href="http://docs.oracle.c
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum 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/CSVRecord.html" target="_top">Frames</a></li>
-<li><a href="CSVRecord.html" target="_top">No Frames</a></li>
+<li><a href="CSVRecord.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -416,16 +498,16 @@ implements <a href="http://docs.oracle.c
<li>Nested | </li>
<li>Field | </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>Field | </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_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->