mirror of
https://github.com/curioustorvald/Terrarum.git
synced 2026-03-07 20:31:51 +09:00
d5c99aad5e
Former-commit-id: 9340873f9cfb15264004c32d6e4b8f8bd6828d94 Former-commit-id: 1916747c109876aa064412e01204c3aeda9bbbc0
626 lines
38 KiB
HTML
626 lines
38 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>CSVParser (Apache Commons CSV 1.2 API)</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="CSVParser (Apache Commons CSV 1.2 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../org/apache/commons/csv/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CSVParser.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/commons/csv/CSVParser.html" target="_top">Frames</a></li>
|
|
<li><a href="CSVParser.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </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>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.apache.commons.csv</div>
|
|
<h2 title="Class CSVParser" class="title">Class CSVParser</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.apache.commons.csv.CSVParser</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/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>></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public final class <span class="strong">CSVParser</span>
|
|
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
|
|
implements <a href="http://docs.oracle.com/javase/7/docs/api/java/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="http://docs.oracle.com/javase/7/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.
|
|
|
|
Because CSV appears in many different dialects, the parser supports many formats by allowing the
|
|
specification of a <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><code>CSVFormat</code></a>.
|
|
|
|
The parser works record wise. It is not possible to go back, once a record has been parsed from the input stream.
|
|
|
|
<h2>Creating instances</h2>
|
|
<p>
|
|
There are several static factory methods that can be used to create instances for various types of resources:
|
|
</p>
|
|
<ul>
|
|
<li><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.io.File,%20java.nio.charset.Charset,%20org.apache.commons.csv.CSVFormat)"><code>parse(java.io.File, Charset, CSVFormat)</code></a></li>
|
|
<li><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.lang.String,%20org.apache.commons.csv.CSVFormat)"><code>parse(String, CSVFormat)</code></a></li>
|
|
<li><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.net.URL,%20java.nio.charset.Charset,%20org.apache.commons.csv.CSVFormat)"><code>parse(java.net.URL, java.nio.charset.Charset, CSVFormat)</code></a></li>
|
|
</ul>
|
|
<p>
|
|
Alternatively parsers can also be created by passing a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> directly to the sole constructor.
|
|
|
|
For those who like fluent APIs, parsers can be created using <a href="../../../../org/apache/commons/csv/CSVFormat.html#parse(java.io.Reader)"><code>CSVFormat.parse(java.io.Reader)</code></a> as a shortcut:
|
|
</p>
|
|
<pre>
|
|
for(CSVRecord record : CSVFormat.EXCEL.parse(in)) {
|
|
...
|
|
}
|
|
</pre>
|
|
|
|
<h2>Parsing record wise</h2>
|
|
<p>
|
|
To parse a CSV input from a file, you write:
|
|
</p>
|
|
|
|
<pre>
|
|
File csvData = new File("/path/to/csv");
|
|
CSVParser parser = CSVParser.parse(csvData, CSVFormat.RFC4180);
|
|
for (CSVRecord csvRecord : parser) {
|
|
...
|
|
}
|
|
</pre>
|
|
|
|
<p>
|
|
This will read the parse the contents of the file using the
|
|
<a href="http://tools.ietf.org/html/rfc4180" target="_blank">RFC 4180</a> format.
|
|
</p>
|
|
|
|
<p>
|
|
To parse CSV input in a format like Excel, you write:
|
|
</p>
|
|
|
|
<pre>
|
|
CSVParser parser = CSVParser.parse(csvData, CSVFormat.EXCEL);
|
|
for (CSVRecord csvRecord : parser) {
|
|
...
|
|
}
|
|
</pre>
|
|
|
|
<p>
|
|
If the predefined formats don't match the format at hands, custom formats can be defined. More information about
|
|
customising CSVFormats is available in <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><code>CSVFormat JavaDoc</code></a>.
|
|
</p>
|
|
|
|
<h2>Parsing into memory</h2>
|
|
<p>
|
|
If parsing record wise is not desired, the contents of the input can be read completely into memory.
|
|
</p>
|
|
|
|
<pre>
|
|
Reader in = new StringReader("a;b\nc;d");
|
|
CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
|
|
List<CSVRecord> list = parser.getRecords();
|
|
</pre>
|
|
|
|
<p>
|
|
There are two constraints that have to be kept in mind:
|
|
</p>
|
|
|
|
<ol>
|
|
<li>Parsing into memory starts at the current position of the parser. If you have already parsed records from
|
|
the input, those records will not end up in the in memory representation of your CSV data.</li>
|
|
<li>Parsing into memory may consume a lot of system resources depending on the input. For example if you're
|
|
parsing a 150MB file of CSV data the contents will be read completely into memory.</li>
|
|
</ol>
|
|
|
|
<h2>Notes</h2>
|
|
<p>
|
|
Internal parser state is completely covered by the format and the reader-state.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Version:</span></dt>
|
|
<dd>$Id: CSVParser.java 1695167 2015-08-10 21:08:58Z ggregory $</dd>
|
|
<dt><span class="strong">See Also:</span></dt><dd><a href="package-summary.html">package documentation for more details</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<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">
|
|
<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/CSVParser.html#CSVParser(java.io.Reader,%20org.apache.commons.csv.CSVFormat)">CSVParser</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> 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>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#CSVParser(java.io.Reader,%20org.apache.commons.csv.CSVFormat,%20long,%20long)">CSVParser</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#close()">close</a></strong>()</code>
|
|
<div class="block">Closes resources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#getCurrentLineNumber()">getCurrentLineNumber</a></strong>()</code>
|
|
<div class="block">Returns the current line number in the input stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#getHeaderMap()">getHeaderMap</a></strong>()</code>
|
|
<div class="block">Returns a copy of the header map that iterates in column order.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#getRecordNumber()">getRecordNumber</a></strong>()</code>
|
|
<div class="block">Returns the current record number in the input stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#getRecords()">getRecords</a></strong>()</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 class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#isClosed()">isClosed</a></strong>()</code>
|
|
<div class="block">Gets whether this parser is closed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#iterator()">iterator</a></strong>()</code>
|
|
<div class="block">Returns an iterator on the records.</div>
|
|
</td>
|
|
</tr>
|
|
<tr 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><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.io.File,%20java.nio.charset.Charset,%20org.apache.commons.csv.CSVFormat)">parse</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset,
|
|
<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="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr 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><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.lang.String,%20org.apache.commons.csv.CSVFormat)">parse</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr 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><strong><a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.net.URL,%20java.nio.charset.Charset,%20org.apache.commons.csv.CSVFormat)">parse</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset,
|
|
<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 URL.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="CSVParser(java.io.Reader, org.apache.commons.csv.CSVFormat)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CSVParser</h4>
|
|
<pre>public CSVParser(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
|
|
<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/7/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>
|
|
|
|
<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,
|
|
unless you close the <code>reader</code>.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - a Reader containing CSV-formatted input. Must not be null.</dd><dd><code>format</code> - the CSVFormat used for CSV parsing. Must not be null.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the parameters of the format are inconsistent or if either reader or format are null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is a problem reading the header or skipping the first record</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CSVParser(java.io.Reader, org.apache.commons.csv.CSVFormat, long, long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>CSVParser</h4>
|
|
<pre>public CSVParser(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> 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="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">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>
|
|
|
|
<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,
|
|
unless you close the <code>reader</code>.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - a Reader containing CSV-formatted input. Must not be null.</dd><dd><code>format</code> - the CSVFormat used for CSV parsing. Must not be null.</dd><dd><code>characterOffset</code> - Lexer offset when the parser does not start parsing at the beginning of the source.</dd><dd><code>recordNumber</code> - The next record number to assign</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the parameters of the format are inconsistent or if either reader or format are null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is a problem reading the header or skipping the first record</dd><dt><span class="strong">Since:</span></dt>
|
|
<dd>1.1</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="parse(java.io.File, java.nio.charset.Charset, org.apache.commons.csv.CSVFormat)">
|
|
<!-- -->
|
|
</a>
|
|
<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> parse(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset,
|
|
<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/7/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="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>.
|
|
|
|
<p><strong>Note:</strong> This method internally creates a FileReader using
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileReader.html?is-external=true#FileReader(java.io.File)" title="class or interface in java.io"><code>FileReader.FileReader(java.io.File)</code></a> which in turn relies on the default encoding of the JVM that
|
|
is executing the code. If this is insufficient create a URL to the file and use
|
|
<a href="../../../../org/apache/commons/csv/CSVParser.html#parse(java.net.URL,%20java.nio.charset.Charset,%20org.apache.commons.csv.CSVFormat)"><code>parse(URL, Charset, CSVFormat)</code></a></p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - a CSV file. Must not be null.</dd><dd><code>charset</code> - A charset</dd><dd><code>format</code> - the CSVFormat used for CSV parsing. Must not be null.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a new parser</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the parameters of the format are inconsistent or if either file or format are null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="parse(java.lang.String, org.apache.commons.csv.CSVFormat)">
|
|
<!-- -->
|
|
</a>
|
|
<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> parse(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string,
|
|
<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/7/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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - a CSV string. Must not be null.</dd><dd><code>format</code> - the CSVFormat used for CSV parsing. Must not be null.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a new parser</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the parameters of the format are inconsistent or if either string or format are null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="parse(java.net.URL, java.nio.charset.Charset, org.apache.commons.csv.CSVFormat)">
|
|
<!-- -->
|
|
</a>
|
|
<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> parse(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset,
|
|
<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/7/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 URL.
|
|
|
|
<p>
|
|
If you do not read all records from the given <code>url</code>, you should call <a href="../../../../org/apache/commons/csv/CSVParser.html#close()"><code>close()</code></a> on the parser, unless
|
|
you close the <code>url</code>.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - a URL. Must not be null.</dd><dd><code>charset</code> - the charset for the resource. Must not be null.</dd><dd><code>format</code> - the CSVFormat used for CSV parsing. Must not be null.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a new parser</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the parameters of the format are inconsistent or if either url, charset or format are null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="close()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre>public void close()
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">Closes resources.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCurrentLineNumber()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrentLineNumber</h4>
|
|
<pre>public long getCurrentLineNumber()</pre>
|
|
<div class="block">Returns 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
|
|
the record number.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>current line number</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getHeaderMap()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHeaderMap</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> getHeaderMap()</pre>
|
|
<div class="block">Returns a copy of the header map that iterates in column order.
|
|
<p>
|
|
The map keys are column names. The map values are 0-based indices.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of the header map that iterates in column order.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRecordNumber()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRecordNumber</h4>
|
|
<pre>public long getRecordNumber()</pre>
|
|
<div class="block">Returns 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
|
|
the line number.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>current record number</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRecords()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRecords</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/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>> getRecords()
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">Parses the 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>.
|
|
|
|
<p>
|
|
The returned content starts at the current parse-position in the stream.
|
|
</p></div>
|
|
<dl><dt><span class="strong">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="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on parse error or input read-failure</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isClosed()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isClosed</h4>
|
|
<pre>public boolean isClosed()</pre>
|
|
<div class="block">Gets whether this parser is closed.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>whether this parser is closed.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="iterator()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>iterator</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/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>> iterator()</pre>
|
|
<div class="block">Returns an iterator on the records.
|
|
|
|
<p>IOExceptions occurring during the iteration are wrapped in a
|
|
RuntimeException.
|
|
If the parser is closed a call to <code>next()</code> will throw a
|
|
NoSuchElementException.</p></div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/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/7/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>></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../org/apache/commons/csv/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CSVParser.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/commons/csv/CSVParser.html" target="_top">Frames</a></li>
|
|
<li><a href="CSVParser.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </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>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright © 2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|