Modified:
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html
==============================================================================
---
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html
(original)
+++
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html
Thu Feb 2 12:12:49 2023
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>CSVParser (Apache Commons CSV 1.9.0 API)</title>
+<title>CSVParser (Apache Commons CSV 1.10.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css"
title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CSVParser (Apache Commons CSV 1.9.0 API)";
+ parent.document.title="CSVParser (Apache Commons CSV 1.10.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":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":10};
+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":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":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";
@@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<br>
-<pre>public final class <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.139">CSVParser</a>
+<pre>public final class <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.141">CSVParser</a>
extends <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>
implements <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true"
title="class or interface in java.io">Closeable</a></pre>
<div class="block">Parses CSV files according to the specified format.
@@ -226,7 +226,7 @@ implements <a href="https://docs.oracle.
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#CSVParser-java.io.Reader-org.apache.commons.csv.CSVFormat-">CSVParser</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
<a href="../../../../org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a> format)</code>
-<div class="block">Customized CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a></div>
+<div class="block">Constructs a new instance using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a></div>
</td>
</tr>
<tr class="rowColor">
@@ -234,7 +234,7 @@ implements <a href="https://docs.oracle.
<a href="../../../../org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a> format,
long characterOffset,
long recordNumber)</code>
-<div class="block">Customized CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a></div>
+<div class="block">Constructs a new instance using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a></div>
</td>
</tr>
</table>
@@ -261,7 +261,7 @@ implements <a href="https://docs.oracle.
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getCurrentLineNumber--">getCurrentLineNumber</a></span>()</code>
-<div class="block">Returns the current line number in the input stream.</div>
+<div class="block">Gets the current line number in the input stream.</div>
</td>
</tr>
<tr id="i2" class="altColor">
@@ -271,43 +271,67 @@ implements <a href="https://docs.oracle.
</td>
</tr>
<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getHeaderComment--">getHeaderComment</a></span>()</code>
+<div class="block">Gets the header comment, if any.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>,<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"
title="class or interface in java.lang">Integer</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getHeaderMap--">getHeaderMap</a></span>()</code>
-<div class="block">Returns a copy of the header map.</div>
+<div class="block">Gets a copy of the header map as defined in the CSVFormat's
header.</div>
</td>
</tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getHeaderNames--">getHeaderNames</a></span>()</code>
-<div class="block">Returns a read-only list of header names that iterates in
column order.</div>
+<div class="block">Gets a read-only list of header names that iterates in
column order as defined in the CSVFormat's header.</div>
</td>
</tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getRecordNumber--">getRecordNumber</a></span>()</code>
-<div class="block">Returns the current record number in the input stream.</div>
+<div class="block">Gets the current record number in the input stream.</div>
</td>
</tr>
-<tr id="i6" class="altColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getRecords--">getRecords</a></span>()</code>
<div class="block">Parses the CSV input according to the given format and
returns the content as a list of
<a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv"><code>CSVRecords</code></a>.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
+<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#getTrailerComment--">getTrailerComment</a></span>()</code>
+<div class="block">Gets the trailer comment, if any.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#hasHeaderComment--">hasHeaderComment</a></span>()</code>
+<div class="block">Checks whether there is a header comment.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#hasTrailerComment--">hasTrailerComment</a></span>()</code>
+<div class="block">Checks whether there is a trailer comment.</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#isClosed--">isClosed</a></span>()</code>
<div class="block">Tests whether this parser is closed.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"
title="class or interface in java.util">Iterator</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns the record iterator.</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.io.File-java.nio.charset.Charset-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io">File</a> file,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
@@ -315,7 +339,7 @@ implements <a href="https://docs.oracle.
<div class="block">Creates a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"><code>File</code></a>.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.io.InputStream-java.nio.charset.Charset-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"
title="class or interface in java.io">InputStream</a> inputStream,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
@@ -323,7 +347,7 @@ implements <a href="https://docs.oracle.
<div class="block">Creates a CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.nio.file.Path-java.nio.charset.Charset-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true"
title="class or interface in java.nio.file">Path</a> path,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
@@ -331,21 +355,21 @@ implements <a href="https://docs.oracle.
<div class="block">Creates and returns a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true"
title="class or interface in java.nio.file"><code>Path</code></a>, which the
caller MUST close.</div>
</td>
</tr>
-<tr id="i12" class="altColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.io.Reader-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
<a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class
in org.apache.commons.csv">CSVFormat</a> format)</code>
<div class="block">Creates a CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a></div>
</td>
</tr>
-<tr id="i13" class="rowColor">
+<tr id="i17" class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.lang.String-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> string,
<a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class
in org.apache.commons.csv">CSVFormat</a> format)</code>
<div class="block">Creates a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang"><code>String</code></a>.</div>
</td>
</tr>
-<tr id="i14" class="altColor">
+<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a
href="../../../../org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#parse-java.net.URL-java.nio.charset.Charset-org.apache.commons.csv.CSVFormat-">parse</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"
title="class or interface in java.net">URL</a> url,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
@@ -353,7 +377,7 @@ implements <a href="https://docs.oracle.
<div class="block">Creates and returns a parser for the given URL, which the
caller MUST close.</div>
</td>
</tr>
-<tr id="i15" class="rowColor">
+<tr id="i19" class="rowColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVParser.html#stream--">stream</a></span>()</code>
<div class="block">Returns a sequential <code>Stream</code> with this
collection as its source.</div>
@@ -394,10 +418,10 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>CSVParser</h4>
-<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.397">CSVParser</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
+<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.403">CSVParser</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
<a href="../../../../org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
-<div class="block">Customized CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>
+<div class="block">Constructs a new instance using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>
<p>
If you do not read all records from the given <code>reader</code>, you should
call <a
href="../../../../org/apache/commons/csv/CSVParser.html#close--"><code>close()</code></a>
on the parser,
@@ -419,12 +443,12 @@ implements <a href="https://docs.oracle.
<ul class="blockListLast">
<li class="blockList">
<h4>CSVParser</h4>
-<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.424">CSVParser</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
+<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.430">CSVParser</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
<a href="../../../../org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a> format,
long characterOffset,
long recordNumber)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
-<div class="block">Customized CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>
+<div class="block">Constructs a new instance using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>
<p>
If you do not read all records from the given <code>reader</code>, you should
call <a
href="../../../../org/apache/commons/csv/CSVParser.html#close--"><code>close()</code></a>
on the parser,
@@ -458,7 +482,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.225">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io">File</a> file,
+<pre>public static <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/CSVParser.html#line.227">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io">File</a> file,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
@@ -482,7 +506,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.252">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"
title="class or interface in java.io">InputStream</a> inputStream,
+<pre>public static <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/CSVParser.html#line.254">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"
title="class or interface in java.io">InputStream</a> inputStream,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
@@ -513,7 +537,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.276">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true"
title="class or interface in java.nio.file">Path</a> path,
+<pre>public static <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/CSVParser.html#line.278">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true"
title="class or interface in java.nio.file">Path</a> path,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
@@ -539,7 +563,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.301">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
+<pre>public static <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/CSVParser.html#line.303">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a> reader,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a CSV parser using the given <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSVFormat</code></a>
@@ -568,7 +592,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.320">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> string,
+<pre>public static <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/CSVParser.html#line.322">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> string,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang"><code>String</code></a>.</div>
@@ -590,7 +614,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
-<pre>public static <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/CSVParser.html#line.348">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"
title="class or interface in java.net">URL</a> url,
+<pre>public static <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/CSVParser.html#line.350">parse</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"
title="class or interface in java.net">URL</a> url,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"
title="class or interface in java.nio.charset">Charset</a> charset,
<a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
@@ -619,7 +643,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.453">close</a>()
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.458">close</a>()
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes resources.</div>
<dl>
@@ -638,8 +662,8 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getCurrentLineNumber</h4>
-<pre>public long <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.536">getCurrentLineNumber</a>()</pre>
-<div class="block">Returns the current line number in the input stream.
+<pre>public long <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.552">getCurrentLineNumber</a>()</pre>
+<div class="block">Gets the current line number in the input stream.
<p>
<strong>ATTENTION:</strong> If your CSV input has multi-line values, the
returned number does not correspond to
@@ -657,7 +681,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getFirstEndOfLine</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.546">getFirstEndOfLine</a>()</pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.562">getFirstEndOfLine</a>()</pre>
<div class="block">Gets the first end-of-line string encountered.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -667,14 +691,31 @@ implements <a href="https://docs.oracle.
</dl>
</li>
</ul>
+<a name="getHeaderComment--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeaderComment</h4>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.573">getHeaderComment</a>()</pre>
+<div class="block">Gets the header comment, if any.
+ The header comment appears before the header record.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the header comment for this stream, or null if no comment is
available.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
<a name="getHeaderMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderMap</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>,<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"
title="class or interface in java.lang">Integer</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.562">getHeaderMap</a>()</pre>
-<div class="block">Returns a copy of the header map.
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>,<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"
title="class or interface in java.lang">Integer</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.589">getHeaderMap</a>()</pre>
+<div class="block">Gets a copy of the header map as defined in the CSVFormat's
header.
<p>
The map keys are column names. The map values are 0-based indices.
</p>
@@ -694,8 +735,8 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getHeaderNames</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.592">getHeaderNames</a>()</pre>
-<div class="block">Returns a read-only list of header names that iterates in
column order.
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.619">getHeaderNames</a>()</pre>
+<div class="block">Gets a read-only list of header names that iterates in
column order as defined in the CSVFormat's header.
<p>
Note: The list provides strings that can be used as keys in the header map.
The list will not contain null column names if they were present in the input
@@ -717,8 +758,8 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getRecordNumber</h4>
-<pre>public long <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.606">getRecordNumber</a>()</pre>
-<div class="block">Returns the current record number in the input stream.
+<pre>public long <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.633">getRecordNumber</a>()</pre>
+<div class="block">Gets the current record number in the input stream.
<p>
<strong>ATTENTION:</strong> If your CSV input has multi-line values, the
returned number does not correspond to
@@ -736,8 +777,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getRecords</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.622">getRecords</a>()
- throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.649">getRecords</a>()</pre>
<div class="block">Parses the CSV input according to the given format and
returns the content as a list of
<a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv"><code>CSVRecords</code></a>.
@@ -748,7 +788,65 @@ implements <a href="https://docs.oracle.
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of <a href="../../../../org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv"><code>CSVRecords</code></a>, may be
empty</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></code> - on parse error
or input read-failure</dd>
+<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/UncheckedIOException.html?is-external=true"
title="class or interface in java.io">UncheckedIOException</a></code> - on
parse error or input read-failure</dd>
+</dl>
+</li>
+</ul>
+<a name="getTrailerComment--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTrailerComment</h4>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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/CSVParser.html#line.660">getTrailerComment</a>()</pre>
+<div class="block">Gets the trailer comment, if any.
+ Trailer comments are located between the last record and EOF</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the trailer comment for this stream, or null if no comment is
available.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
+<a name="hasHeaderComment--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasHeaderComment</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.695">hasHeaderComment</a>()</pre>
+<div class="block">Checks whether there is a header comment.
+ The header comment appears before the header record.
+ Note that if the parser's format has been given an explicit header
+ (with <a
href="../../../../org/apache/commons/csv/CSVFormat.Builder.html#setHeader-java.lang.String...-"><code>CSVFormat.Builder.setHeader(String...
)</code></a> or another overload)
+ and the header record is not being skipped
+ (<a
href="../../../../org/apache/commons/csv/CSVFormat.Builder.html#setSkipHeaderRecord-boolean-"><code>CSVFormat.Builder.setSkipHeaderRecord(boolean)</code></a>
is false) then any initial comments
+ will be associated with the first record, not the header.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if this parser has seen a header comment, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
+<a name="hasTrailerComment--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasTrailerComment</h4>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.708">hasTrailerComment</a>()</pre>
+<div class="block">Checks whether there is a trailer comment.
+ Trailer comments are located between the last record and EOF.
+ The trailer comments will only be available after the parser has
+ finished processing this stream.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if this parser has seen a trailer comment, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
</dl>
</li>
</ul>
@@ -758,7 +856,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
-<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.655">isClosed</a>()</pre>
+<pre>public boolean <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.717">isClosed</a>()</pre>
<div class="block">Tests whether this parser is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -772,7 +870,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"
title="class or interface in java.util">Iterator</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.683">iterator</a>()</pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"
title="class or interface in java.util">Iterator</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.752">iterator</a>()</pre>
<div class="block">Returns the record iterator.
<p>
@@ -780,8 +878,15 @@ implements <a href="https://docs.oracle.
<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true"
title="class or interface in java.lang"><code>IllegalStateException</code></a>.
</p>
<p>
- If the parser is closed a call to <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#next--"
title="class or interface in java.util"><code>Iterator.next()</code></a> will
throw a
+ If the parser is closed, the iterator will not yield any more records.
+ A call to <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#hasNext--"
title="class or interface in java.util"><code>Iterator.hasNext()</code></a>
will return <code>false</code> and
+ a call to <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#next--"
title="class or interface in java.util"><code>Iterator.next()</code></a> will
throw a
<a
href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true"
title="class or interface in
java.util"><code>NoSuchElementException</code></a>.
+ </p>
+ <p>
+ If it is necessary to construct an iterator which is usable after the
+ parser is closed, one option is to extract all records as a list with
+ <a
href="../../../../org/apache/commons/csv/CSVParser.html#getRecords--"><code>getRecords()</code></a>,
and return an iterator to that list.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -795,8 +900,12 @@ implements <a href="https://docs.oracle.
<ul class="blockListLast">
<li class="blockList">
<h4>stream</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.745">stream</a>()</pre>
-<div class="block">Returns a sequential <code>Stream</code> with this
collection as its source.</div>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><<a
href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in
org.apache.commons.csv">CSVRecord</a>> <a
href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.819">stream</a>()</pre>
+<div class="block">Returns a sequential <code>Stream</code> with this
collection as its source.
+ <p>
+ If the parser is closed, the stream will not produce any more values.
+ See the comments in <a
href="../../../../org/apache/commons/csv/CSVParser.html#iterator--"><code>iterator()</code></a>.
+ </p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a sequential <code>Stream</code> with this collection as its source.</dd>
@@ -873,6 +982,6 @@ implements <a href="https://docs.oracle.
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2005–2020 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2005–2022 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
</body>
</html>
\ No newline at end of file
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 Feb 2 12:12:49 2023
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>CSVPrinter (Apache Commons CSV 1.9.0 API)</title>
+<title>CSVPrinter (Apache Commons CSV 1.10.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css"
title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CSVPrinter (Apache Commons CSV 1.9.0 API)";
+ parent.document.title="CSVPrinter (Apache Commons CSV 1.10.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};
+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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<br>
-<pre>public final class <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.70">CSVPrinter</a>
+<pre>public final class <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.71">CSVPrinter</a>
extends <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>
implements <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html?is-external=true"
title="class or interface in java.io">Flushable</a>, <a
href="https://docs.oracle.com/javase/8/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 <a
href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in
org.apache.commons.csv"><code>CSV format</code></a>.
@@ -237,40 +237,52 @@ implements <a href="https://docs.oracle.
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Iterable-">printRecord</a></span>(<a
href="https://docs.oracle.com/javase/8/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>
+<div class="block">Prints the given values as a single record of delimiter
separated values followed by the record separator.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.lang.Object...-">printRecord</a></span>(<a
href="https://docs.oracle.com/javase/8/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>
+<div class="block">Prints the given values as a single record of delimiter
separated values followed by the record separator.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.lang.Iterable-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/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 class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecord-java.util.stream.Stream-">printRecord</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in
java.util.stream">Stream</a><?> values)</code>
+<div class="block">Prints the given values as a single record of delimiter
separated values followed by the record separator.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.lang.Iterable-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/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 <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang"><code>Iterable</code></a> handling
nested collections/arrays as records.</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.lang.Object...-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/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 id="i12" class="altColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.sql.ResultSet-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/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>
-<tr id="i13" class="rowColor">
+<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.sql.ResultSet-boolean-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true"
title="class or interface in java.sql">ResultSet</a> resultSet,
boolean printHeader)</code>
<div class="block">Prints all the objects with metadata in the given JDBC
result set based on the header boolean.</div>
</td>
</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVPrinter.html#printRecords-java.util.stream.Stream-">printRecords</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in
java.util.stream">Stream</a><?> values)</code>
+<div class="block">Prints all the objects in the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream"><code>Stream</code></a>
handling nested collections/arrays as records.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -299,7 +311,7 @@ implements <a href="https://docs.oracle.
<ul class="blockListLast">
<li class="blockList">
<h4>CSVPrinter</h4>
-<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.95">CSVPrinter</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"
title="class or interface in java.lang">Appendable</a> appendable,
+<pre>public <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.97">CSVPrinter</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"
title="class or interface in java.lang">Appendable</a> appendable,
<a href="../../../../org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a> format)
throws <a
href="https://docs.oracle.com/javase/8/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.
@@ -331,7 +343,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.114">close</a>()
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.117">close</a>()
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -349,7 +361,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.126">close</a>(boolean flush)
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.129">close</a>(boolean flush)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes the underlying stream with an optional flush
first.</div>
<dl>
@@ -368,7 +380,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.142">flush</a>()
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.145">flush</a>()
throws <a
href="https://docs.oracle.com/javase/8/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>
@@ -385,7 +397,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>getOut</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/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.153">getOut</a>()</pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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.156">getOut</a>()</pre>
<div class="block">Gets the target Appendable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -399,7 +411,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.165">print</a>(<a
href="https://docs.oracle.com/javase/8/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.168">print</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> value)
throws <a
href="https://docs.oracle.com/javase/8/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>
@@ -416,7 +428,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printComment</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.191">printComment</a>(<a
href="https://docs.oracle.com/javase/8/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.194">printComment</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> comment)
throws <a
href="https://docs.oracle.com/javase/8/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.
@@ -446,7 +458,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printHeaders</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.229">printHeaders</a>(<a
href="https://docs.oracle.com/javase/8/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.232">printHeaders</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true"
title="class or interface in java.sql">ResultSet</a> resultSet)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a>,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true"
title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Prints headers for a result set based on its metadata.</div>
@@ -467,7 +479,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.239">println</a>()
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.242">println</a>()
throws <a
href="https://docs.oracle.com/javase/8/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>
@@ -482,9 +494,9 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printRecord</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.257">printRecord</a>(<a
href="https://docs.oracle.com/javase/8/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.260">printRecord</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</a><?> values)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
-<div class="block">Prints the given values a single record of delimiter
separated values followed by the record separator.
+<div class="block">Prints the given values as 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
@@ -504,9 +516,9 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printRecord</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.277">printRecord</a>(<a
href="https://docs.oracle.com/javase/8/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.280">printRecord</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>... values)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
-<div class="block">Prints the given values a single record of delimiter
separated values followed by the record separator.
+<div class="block">Prints the given values as 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
@@ -520,19 +532,43 @@ implements <a href="https://docs.oracle.
</dl>
</li>
</ul>
+<a name="printRecord-java.util.stream.Stream-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>printRecord</h4>
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.298">printRecord</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><?> values)
+ throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
+<div class="block">Prints the given values as 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="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></code> - If an I/O error
occurs</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
<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.320">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/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.358">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</a><?> values)
throws <a
href="https://docs.oracle.com/javase/8/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 handling
nested collections/arrays as records.
+<div class="block">Prints all the objects in the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang"><code>Iterable</code></a> 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
+ If the given Iterable 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 Iterable 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>
@@ -542,7 +578,7 @@ implements <a href="https://docs.oracle.
<pre>
<code>
- List<String[]> data = ...
+ List<String[]> data = new ArrayList<>();
data.add(new String[]{ "A", "B", "C" });
data.add(new String[]{ "1", "2", "3" });
data.add(new String[]{ "A1", "B2", "C3" });
@@ -574,7 +610,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.371">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/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.403">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>... values)
throws <a
href="https://docs.oracle.com/javase/8/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 handling nested
collections/arrays as records.
@@ -622,7 +658,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.385">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/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.417">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true"
title="class or interface in java.sql">ResultSet</a> resultSet)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true"
title="class or interface in java.sql">SQLException</a>,
<a
href="https://docs.oracle.com/javase/8/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>
@@ -638,10 +674,10 @@ implements <a href="https://docs.oracle.
<a name="printRecords-java.sql.ResultSet-boolean-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>printRecords</h4>
-<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.406">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/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.438">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true"
title="class or interface in java.sql">ResultSet</a> resultSet,
boolean printHeader)
throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true"
title="class or interface in java.sql">SQLException</a>,
<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></pre>
@@ -658,6 +694,57 @@ implements <a href="https://docs.oracle.
</dl>
</li>
</ul>
+<a name="printRecords-java.util.stream.Stream-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>printRecords</h4>
+<pre>public void <a
href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.487">printRecords</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><?> values)
+ throws <a
href="https://docs.oracle.com/javase/8/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 <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream"><code>Stream</code></a>
handling nested collections/arrays as records.
+
+ <p>
+ If the given Stream 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 Stream 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 = new ArrayList<>();
+ data.add(new String[]{ "A", "B", "C" });
+ data.add(new String[]{ "1", "2", "3" });
+ data.add(new String[]{ "A1", "B2", "C3" });
+ Stream<String[]> stream = data.stream();
+ </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="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io">IOException</a></code> - If an I/O error
occurs</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>
@@ -726,6 +813,6 @@ implements <a href="https://docs.oracle.
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2005–2020 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2005–2022 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
</body>
</html>
\ No newline at end of file
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 Feb 2 12:12:49 2023
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>CSVRecord (Apache Commons CSV 1.9.0 API)</title>
+<title>CSVRecord (Apache Commons CSV 1.10.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css"
title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CSVRecord (Apache Commons CSV 1.9.0 API)";
+ parent.document.title="CSVRecord (Apache Commons CSV 1.10.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};
+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":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<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>
+<li><a href="../../../../org/apache/commons/csv/DuplicateHeaderMode.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>
@@ -246,7 +246,7 @@ implements <a href="https://docs.oracle.
<tr id="i16" class="altColor">
<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVRecord.html#toList--">toList</a></span>()</code>
-<div class="block">Converts the values to a List.</div>
+<div class="block">Converts the values to a new List.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
@@ -261,6 +261,12 @@ implements <a href="https://docs.oracle.
<div class="block">Returns a string representation of the contents of this
record.</div>
</td>
</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/commons/csv/CSVRecord.html#values--">values</a></span>()</code>
+<div class="block">Gets the values for this record.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -558,7 +564,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
-<pre>public int <a
href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.287">size</a>()</pre>
+<pre>public int <a
href="../../../../src-html/org/apache/commons/csv/CSVRecord.html#line.286">size</a>()</pre>
<div class="block">Returns the number of values in this record.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -572,7 +578,7 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>stream</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><<a
href="https://docs.oracle.com/javase/8/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.297">stream</a>()</pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"
title="class or interface in java.util.stream">Stream</a><<a
href="https://docs.oracle.com/javase/8/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.296">stream</a>()</pre>
<div class="block">Returns a sequential ordered stream whose elements are the
values.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -588,8 +594,11 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>toList</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/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.307">toList</a>()</pre>
-<div class="block">Converts the values to a List.</div>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/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.309">toList</a>()</pre>
+<div class="block">Converts the values to a new List.
+ <p>
+ Editing the list does not update this instance.
+ </p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new List</dd>
@@ -604,8 +613,11 @@ implements <a href="https://docs.oracle.
<ul class="blockList">
<li class="blockList">
<h4>toMap</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>,<a
href="https://docs.oracle.com/javase/8/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.316">toMap</a>()</pre>
-<div class="block">Copies this record into a new Map of header name to record
value.</div>
+<pre>public <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>,<a
href="https://docs.oracle.com/javase/8/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.321">toMap</a>()</pre>
+<div class="block">Copies this record into a new Map of header name to record
value.
+ <p>
+ Editing the map does not update this instance.
+ </p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new Map. The map is empty if the record has no headers.</dd>
@@ -615,10 +627,10 @@ implements <a href="https://docs.oracle.
<a name="toString--">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
-<pre>public <a
href="https://docs.oracle.com/javase/8/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.327">toString</a>()</pre>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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.332">toString</a>()</pre>
<div class="block">Returns a string representation of the contents of this
record. The result is constructed by comment, mapping,
recordNumber and by passing the internal values array to <a
href="https://docs.oracle.com/javase/8/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>
@@ -629,6 +641,22 @@ implements <a href="https://docs.oracle.
</dl>
</li>
</ul>
+<a name="values--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>values</h4>
+<pre>public <a
href="https://docs.oracle.com/javase/8/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.343">values</a>()</pre>
+<div class="block">Gets the values for this record. This is not a copy.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the values for this record.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.10.0</dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>
@@ -657,7 +685,7 @@ implements <a href="https://docs.oracle.
<div class="subNav">
<ul class="navList">
<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>
+<li><a href="../../../../org/apache/commons/csv/DuplicateHeaderMode.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>
@@ -697,6 +725,6 @@ implements <a href="https://docs.oracle.
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2005–2020 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2005–2022 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
</body>
</html>
\ No newline at end of file