Modified: websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVParser.Builder.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVParser.Builder.html (original) +++ websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVParser.Builder.html Wed Mar 19 22:20:06 2025 @@ -1,12 +1,12 @@ <!DOCTYPE HTML> <html lang> <head> -<!-- Generated by javadoc (23) --> +<!-- Generated by javadoc (17) --> <title>Source code</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="source: package: org.apache.commons.csv, class: CSVParser, class: Builder"> <meta name="generator" content="javadoc/SourceToHTMLConverter"> -<link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body class="source-page"> <main role="main"> @@ -62,304 +62,304 @@ <span class="source-line-no">049</span><span id="line-49">import java.util.stream.Stream;</span> <span class="source-line-no">050</span><span id="line-50">import java.util.stream.StreamSupport;</span> <span class="source-line-no">051</span><span id="line-51"></span> -<span class="source-line-no">052</span><span id="line-52">import org.apache.commons.io.build.AbstractStreamBuilder;</span> -<span class="source-line-no">053</span><span id="line-53">import org.apache.commons.io.function.Uncheck;</span> -<span class="source-line-no">054</span><span id="line-54"></span> -<span class="source-line-no">055</span><span id="line-55">/**</span> -<span class="source-line-no">056</span><span id="line-56"> * Parses CSV files according to the specified format.</span> -<span class="source-line-no">057</span><span id="line-57"> *</span> -<span class="source-line-no">058</span><span id="line-58"> * Because CSV appears in many different dialects, the parser supports many formats by allowing the</span> -<span class="source-line-no">059</span><span id="line-59"> * specification of a {@link CSVFormat}.</span> -<span class="source-line-no">060</span><span id="line-60"> *</span> -<span class="source-line-no">061</span><span id="line-61"> * The parser works record-wise. It is not possible to go back, once a record has been parsed from the input stream.</span> -<span class="source-line-no">062</span><span id="line-62"> *</span> -<span class="source-line-no">063</span><span id="line-63"> * <h2>Creating instances</h2></span> -<span class="source-line-no">064</span><span id="line-64"> * <p></span> -<span class="source-line-no">065</span><span id="line-65"> * There are several static factory methods that can be used to create instances for various types of resources:</span> -<span class="source-line-no">066</span><span id="line-66"> * </p></span> -<span class="source-line-no">067</span><span id="line-67"> * <ul></span> -<span class="source-line-no">068</span><span id="line-68"> * <li>{@link #parse(java.io.File, Charset, CSVFormat)}</li></span> -<span class="source-line-no">069</span><span id="line-69"> * <li>{@link #parse(String, CSVFormat)}</li></span> -<span class="source-line-no">070</span><span id="line-70"> * <li>{@link #parse(java.net.URL, java.nio.charset.Charset, CSVFormat)}</li></span> -<span class="source-line-no">071</span><span id="line-71"> * </ul></span> -<span class="source-line-no">072</span><span id="line-72"> * <p></span> -<span class="source-line-no">073</span><span id="line-73"> * Alternatively parsers can also be created by passing a {@link Reader} directly to the sole constructor.</span> -<span class="source-line-no">074</span><span id="line-74"> *</span> -<span class="source-line-no">075</span><span id="line-75"> * For those who like fluent APIs, parsers can be created using {@link CSVFormat#parse(java.io.Reader)} as a shortcut:</span> -<span class="source-line-no">076</span><span id="line-76"> * </p></span> -<span class="source-line-no">077</span><span id="line-77"> * <pre></span> -<span class="source-line-no">078</span><span id="line-78"> * for (CSVRecord record : CSVFormat.EXCEL.parse(in)) {</span> -<span class="source-line-no">079</span><span id="line-79"> * ...</span> -<span class="source-line-no">080</span><span id="line-80"> * }</span> -<span class="source-line-no">081</span><span id="line-81"> * </pre></span> -<span class="source-line-no">082</span><span id="line-82"> *</span> -<span class="source-line-no">083</span><span id="line-83"> * <h2>Parsing record wise</h2></span> -<span class="source-line-no">084</span><span id="line-84"> * <p></span> -<span class="source-line-no">085</span><span id="line-85"> * To parse a CSV input from a file, you write:</span> -<span class="source-line-no">086</span><span id="line-86"> * </p></span> -<span class="source-line-no">087</span><span id="line-87"> *</span> -<span class="source-line-no">088</span><span id="line-88"> * <pre>{@code</span> -<span class="source-line-no">089</span><span id="line-89"> * File csvData = new File("/path/to/csv");</span> -<span class="source-line-no">090</span><span id="line-90"> * CSVParser parser = CSVParser.parse(csvData, CSVFormat.RFC4180);</span> -<span class="source-line-no">091</span><span id="line-91"> * for (CSVRecord csvRecord : parser) {</span> -<span class="source-line-no">092</span><span id="line-92"> * ...</span> -<span class="source-line-no">093</span><span id="line-93"> * }}</span> -<span class="source-line-no">094</span><span id="line-94"> * </pre></span> -<span class="source-line-no">095</span><span id="line-95"> *</span> -<span class="source-line-no">096</span><span id="line-96"> * <p></span> -<span class="source-line-no">097</span><span id="line-97"> * This will read the parse the contents of the file using the</span> -<span class="source-line-no">098</span><span id="line-98"> * <a href="https://tools.ietf.org/html/rfc4180" target="_blank">RFC 4180</a> format.</span> -<span class="source-line-no">099</span><span id="line-99"> * </p></span> -<span class="source-line-no">100</span><span id="line-100"> *</span> -<span class="source-line-no">101</span><span id="line-101"> * <p></span> -<span class="source-line-no">102</span><span id="line-102"> * To parse CSV input in a format like Excel, you write:</span> -<span class="source-line-no">103</span><span id="line-103"> * </p></span> -<span class="source-line-no">104</span><span id="line-104"> *</span> -<span class="source-line-no">105</span><span id="line-105"> * <pre></span> -<span class="source-line-no">106</span><span id="line-106"> * CSVParser parser = CSVParser.parse(csvData, CSVFormat.EXCEL);</span> -<span class="source-line-no">107</span><span id="line-107"> * for (CSVRecord csvRecord : parser) {</span> -<span class="source-line-no">108</span><span id="line-108"> * ...</span> -<span class="source-line-no">109</span><span id="line-109"> * }</span> -<span class="source-line-no">110</span><span id="line-110"> * </pre></span> -<span class="source-line-no">111</span><span id="line-111"> *</span> -<span class="source-line-no">112</span><span id="line-112"> * <p></span> -<span class="source-line-no">113</span><span id="line-113"> * If the predefined formats don't match the format at hand, custom formats can be defined. More information about</span> -<span class="source-line-no">114</span><span id="line-114"> * customizing CSVFormats is available in {@link CSVFormat CSVFormat Javadoc}.</span> -<span class="source-line-no">115</span><span id="line-115"> * </p></span> -<span class="source-line-no">116</span><span id="line-116"> *</span> -<span class="source-line-no">117</span><span id="line-117"> * <h2>Parsing into memory</h2></span> -<span class="source-line-no">118</span><span id="line-118"> * <p></span> -<span class="source-line-no">119</span><span id="line-119"> * If parsing record-wise is not desired, the contents of the input can be read completely into memory.</span> -<span class="source-line-no">120</span><span id="line-120"> * </p></span> -<span class="source-line-no">121</span><span id="line-121"> *</span> -<span class="source-line-no">122</span><span id="line-122"> * <pre>{@code</span> -<span class="source-line-no">123</span><span id="line-123"> * Reader in = new StringReader("a;b\nc;d");</span> -<span class="source-line-no">124</span><span id="line-124"> * CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);</span> -<span class="source-line-no">125</span><span id="line-125"> * List<CSVRecord> list = parser.getRecords();</span> -<span class="source-line-no">126</span><span id="line-126"> * }</pre></span> -<span class="source-line-no">127</span><span id="line-127"> *</span> -<span class="source-line-no">128</span><span id="line-128"> * <p></span> -<span class="source-line-no">129</span><span id="line-129"> * There are two constraints that have to be kept in mind:</span> -<span class="source-line-no">130</span><span id="line-130"> * </p></span> -<span class="source-line-no">131</span><span id="line-131"> *</span> -<span class="source-line-no">132</span><span id="line-132"> * <ol></span> -<span class="source-line-no">133</span><span id="line-133"> * <li>Parsing into memory starts at the current position of the parser. If you have already parsed records from</span> -<span class="source-line-no">134</span><span id="line-134"> * the input, those records will not end up in the in-memory representation of your CSV data.</li></span> -<span class="source-line-no">135</span><span id="line-135"> * <li>Parsing into memory may consume a lot of system resources depending on the input. For example, if you're</span> -<span class="source-line-no">136</span><span id="line-136"> * parsing a 150MB file of CSV data the contents will be read completely into memory.</li></span> -<span class="source-line-no">137</span><span id="line-137"> * </ol></span> -<span class="source-line-no">138</span><span id="line-138"> *</span> -<span class="source-line-no">139</span><span id="line-139"> * <h2>Notes</h2></span> -<span class="source-line-no">140</span><span id="line-140"> * <p></span> -<span class="source-line-no">141</span><span id="line-141"> * The internal parser state is completely covered by the format and the reader state.</span> -<span class="source-line-no">142</span><span id="line-142"> * </p></span> -<span class="source-line-no">143</span><span id="line-143"> *</span> -<span class="source-line-no">144</span><span id="line-144"> * @see <a href="package-summary.html">package documentation for more details</a></span> -<span class="source-line-no">145</span><span id="line-145"> */</span> -<span class="source-line-no">146</span><span id="line-146">public final class CSVParser implements Iterable<CSVRecord>, Closeable {</span> -<span class="source-line-no">147</span><span id="line-147"></span> -<span class="source-line-no">148</span><span id="line-148"> /**</span> -<span class="source-line-no">149</span><span id="line-149"> * Builds a new {@link CSVParser}.</span> -<span class="source-line-no">150</span><span id="line-150"> *</span> -<span class="source-line-no">151</span><span id="line-151"> * @since 1.13.0</span> -<span class="source-line-no">152</span><span id="line-152"> */</span> -<span class="source-line-no">153</span><span id="line-153"> public static class Builder extends AbstractStreamBuilder<CSVParser, Builder> {</span> -<span class="source-line-no">154</span><span id="line-154"></span> -<span class="source-line-no">155</span><span id="line-155"> private CSVFormat format;</span> -<span class="source-line-no">156</span><span id="line-156"> private long characterOffset;</span> -<span class="source-line-no">157</span><span id="line-157"> private long recordNumber = 1;</span> -<span class="source-line-no">158</span><span id="line-158"> private boolean trackBytes;</span> -<span class="source-line-no">159</span><span id="line-159"></span> -<span class="source-line-no">160</span><span id="line-160"> /**</span> -<span class="source-line-no">161</span><span id="line-161"> * Constructs a new instance.</span> -<span class="source-line-no">162</span><span id="line-162"> */</span> -<span class="source-line-no">163</span><span id="line-163"> protected Builder() {</span> -<span class="source-line-no">164</span><span id="line-164"> // empty</span> -<span class="source-line-no">165</span><span id="line-165"> }</span> -<span class="source-line-no">166</span><span id="line-166"></span> -<span class="source-line-no">167</span><span id="line-167"> @SuppressWarnings("resource")</span> -<span class="source-line-no">168</span><span id="line-168"> @Override</span> -<span class="source-line-no">169</span><span id="line-169"> public CSVParser get() throws IOException {</span> -<span class="source-line-no">170</span><span id="line-170"> return new CSVParser(getReader(), format != null ? format : CSVFormat.DEFAULT, characterOffset, recordNumber, getCharset(), trackBytes);</span> -<span class="source-line-no">171</span><span id="line-171"> }</span> -<span class="source-line-no">172</span><span id="line-172"></span> -<span class="source-line-no">173</span><span id="line-173"> /**</span> -<span class="source-line-no">174</span><span id="line-174"> * Sets the lexer offset when the parser does not start parsing at the beginning of the source.</span> -<span class="source-line-no">175</span><span id="line-175"> *</span> -<span class="source-line-no">176</span><span id="line-176"> * @param characterOffset the lexer offset.</span> -<span class="source-line-no">177</span><span id="line-177"> * @return this instance.</span> -<span class="source-line-no">178</span><span id="line-178"> */</span> -<span class="source-line-no">179</span><span id="line-179"> public Builder setCharacterOffset(final long characterOffset) {</span> -<span class="source-line-no">180</span><span id="line-180"> this.characterOffset = characterOffset;</span> -<span class="source-line-no">181</span><span id="line-181"> return asThis();</span> -<span class="source-line-no">182</span><span id="line-182"> }</span> -<span class="source-line-no">183</span><span id="line-183"></span> -<span class="source-line-no">184</span><span id="line-184"> /**</span> -<span class="source-line-no">185</span><span id="line-185"> * Sets the CSV format. A copy of the given format is kept.</span> -<span class="source-line-no">186</span><span id="line-186"> *</span> -<span class="source-line-no">187</span><span id="line-187"> * @param format the CSV format, null is equivalent to {@link CSVFormat#DEFAULT}.</span> -<span class="source-line-no">188</span><span id="line-188"> * @return this instance.</span> -<span class="source-line-no">189</span><span id="line-189"> */</span> -<span class="source-line-no">190</span><span id="line-190"> public Builder setFormat(final CSVFormat format) {</span> -<span class="source-line-no">191</span><span id="line-191"> this.format = CSVFormat.copy(format);</span> -<span class="source-line-no">192</span><span id="line-192"> return asThis();</span> -<span class="source-line-no">193</span><span id="line-193"> }</span> -<span class="source-line-no">194</span><span id="line-194"></span> -<span class="source-line-no">195</span><span id="line-195"> /**</span> -<span class="source-line-no">196</span><span id="line-196"> * Sets the next record number to assign, defaults to {@code 1}.</span> -<span class="source-line-no">197</span><span id="line-197"> *</span> -<span class="source-line-no">198</span><span id="line-198"> * @param recordNumber the next record number to assign.</span> -<span class="source-line-no">199</span><span id="line-199"> * @return this instance.</span> -<span class="source-line-no">200</span><span id="line-200"> */</span> -<span class="source-line-no">201</span><span id="line-201"> public Builder setRecordNumber(final long recordNumber) {</span> -<span class="source-line-no">202</span><span id="line-202"> this.recordNumber = recordNumber;</span> -<span class="source-line-no">203</span><span id="line-203"> return asThis();</span> -<span class="source-line-no">204</span><span id="line-204"> }</span> -<span class="source-line-no">205</span><span id="line-205"></span> -<span class="source-line-no">206</span><span id="line-206"> /**</span> -<span class="source-line-no">207</span><span id="line-207"> * Sets whether to enable byte tracking for the parser.</span> -<span class="source-line-no">208</span><span id="line-208"> *</span> -<span class="source-line-no">209</span><span id="line-209"> * @param trackBytes {@code true} to enable byte tracking; {@code false} to disable it.</span> -<span class="source-line-no">210</span><span id="line-210"> * @return this instance.</span> -<span class="source-line-no">211</span><span id="line-211"> * @since 1.13.0</span> -<span class="source-line-no">212</span><span id="line-212"> */</span> -<span class="source-line-no">213</span><span id="line-213"> public Builder setTrackBytes(final boolean trackBytes) {</span> -<span class="source-line-no">214</span><span id="line-214"> this.trackBytes = trackBytes;</span> -<span class="source-line-no">215</span><span id="line-215"> return asThis();</span> -<span class="source-line-no">216</span><span id="line-216"> }</span> -<span class="source-line-no">217</span><span id="line-217"></span> -<span class="source-line-no">218</span><span id="line-218"> }</span> -<span class="source-line-no">219</span><span id="line-219"></span> -<span class="source-line-no">220</span><span id="line-220"> final class CSVRecordIterator implements Iterator<CSVRecord> {</span> -<span class="source-line-no">221</span><span id="line-221"> private CSVRecord current;</span> -<span class="source-line-no">222</span><span id="line-222"></span> -<span class="source-line-no">223</span><span id="line-223"> /**</span> -<span class="source-line-no">224</span><span id="line-224"> * Gets the next record.</span> -<span class="source-line-no">225</span><span id="line-225"> *</span> -<span class="source-line-no">226</span><span id="line-226"> * @throws IOException on parse error or input read-failure</span> -<span class="source-line-no">227</span><span id="line-227"> * @throws CSVException on invalid input.</span> -<span class="source-line-no">228</span><span id="line-228"> * @return the next record.</span> -<span class="source-line-no">229</span><span id="line-229"> */</span> -<span class="source-line-no">230</span><span id="line-230"> private CSVRecord getNextRecord() {</span> -<span class="source-line-no">231</span><span id="line-231"> return Uncheck.get(CSVParser.this::nextRecord);</span> -<span class="source-line-no">232</span><span id="line-232"> }</span> -<span class="source-line-no">233</span><span id="line-233"></span> -<span class="source-line-no">234</span><span id="line-234"> @Override</span> -<span class="source-line-no">235</span><span id="line-235"> public boolean hasNext() {</span> -<span class="source-line-no">236</span><span id="line-236"> if (isClosed()) {</span> -<span class="source-line-no">237</span><span id="line-237"> return false;</span> -<span class="source-line-no">238</span><span id="line-238"> }</span> -<span class="source-line-no">239</span><span id="line-239"> if (current == null) {</span> -<span class="source-line-no">240</span><span id="line-240"> current = getNextRecord();</span> -<span class="source-line-no">241</span><span id="line-241"> }</span> -<span class="source-line-no">242</span><span id="line-242"></span> -<span class="source-line-no">243</span><span id="line-243"> return current != null;</span> -<span class="source-line-no">244</span><span id="line-244"> }</span> -<span class="source-line-no">245</span><span id="line-245"></span> -<span class="source-line-no">246</span><span id="line-246"> @Override</span> -<span class="source-line-no">247</span><span id="line-247"> public CSVRecord next() {</span> -<span class="source-line-no">248</span><span id="line-248"> if (isClosed()) {</span> -<span class="source-line-no">249</span><span id="line-249"> throw new NoSuchElementException("CSVParser has been closed");</span> -<span class="source-line-no">250</span><span id="line-250"> }</span> -<span class="source-line-no">251</span><span id="line-251"> CSVRecord next = current;</span> -<span class="source-line-no">252</span><span id="line-252"> current = null;</span> -<span class="source-line-no">253</span><span id="line-253"></span> -<span class="source-line-no">254</span><span id="line-254"> if (next == null) {</span> -<span class="source-line-no">255</span><span id="line-255"> // hasNext() wasn't called before</span> -<span class="source-line-no">256</span><span id="line-256"> next = getNextRecord();</span> -<span class="source-line-no">257</span><span id="line-257"> if (next == null) {</span> -<span class="source-line-no">258</span><span id="line-258"> throw new NoSuchElementException("No more CSV records available");</span> -<span class="source-line-no">259</span><span id="line-259"> }</span> -<span class="source-line-no">260</span><span id="line-260"> }</span> -<span class="source-line-no">261</span><span id="line-261"></span> -<span class="source-line-no">262</span><span id="line-262"> return next;</span> -<span class="source-line-no">263</span><span id="line-263"> }</span> -<span class="source-line-no">264</span><span id="line-264"></span> -<span class="source-line-no">265</span><span id="line-265"> @Override</span> -<span class="source-line-no">266</span><span id="line-266"> public void remove() {</span> -<span class="source-line-no">267</span><span id="line-267"> throw new UnsupportedOperationException();</span> -<span class="source-line-no">268</span><span id="line-268"> }</span> -<span class="source-line-no">269</span><span id="line-269"> }</span> -<span class="source-line-no">270</span><span id="line-270"> /**</span> -<span class="source-line-no">271</span><span id="line-271"> * Header information based on name and position.</span> -<span class="source-line-no">272</span><span id="line-272"> */</span> -<span class="source-line-no">273</span><span id="line-273"> private static final class Headers {</span> -<span class="source-line-no">274</span><span id="line-274"></span> -<span class="source-line-no">275</span><span id="line-275"> /**</span> -<span class="source-line-no">276</span><span id="line-276"> * Header column positions (0-based)</span> -<span class="source-line-no">277</span><span id="line-277"> */</span> -<span class="source-line-no">278</span><span id="line-278"> final Map<String, Integer> headerMap;</span> -<span class="source-line-no">279</span><span id="line-279"></span> -<span class="source-line-no">280</span><span id="line-280"> /**</span> -<span class="source-line-no">281</span><span id="line-281"> * Header names in column order</span> -<span class="source-line-no">282</span><span id="line-282"> */</span> -<span class="source-line-no">283</span><span id="line-283"> final List<String> headerNames;</span> -<span class="source-line-no">284</span><span id="line-284"></span> -<span class="source-line-no">285</span><span id="line-285"> Headers(final Map<String, Integer> headerMap, final List<String> headerNames) {</span> -<span class="source-line-no">286</span><span id="line-286"> this.headerMap = headerMap;</span> -<span class="source-line-no">287</span><span id="line-287"> this.headerNames = headerNames;</span> -<span class="source-line-no">288</span><span id="line-288"> }</span> -<span class="source-line-no">289</span><span id="line-289"> }</span> -<span class="source-line-no">290</span><span id="line-290"></span> -<span class="source-line-no">291</span><span id="line-291"> /**</span> -<span class="source-line-no">292</span><span id="line-292"> * Creates a new builder.</span> -<span class="source-line-no">293</span><span id="line-293"> *</span> -<span class="source-line-no">294</span><span id="line-294"> * @return a new builder.</span> -<span class="source-line-no">295</span><span id="line-295"> * @since 1.13.0</span> -<span class="source-line-no">296</span><span id="line-296"> */</span> -<span class="source-line-no">297</span><span id="line-297"> public static Builder builder() {</span> -<span class="source-line-no">298</span><span id="line-298"> return new Builder();</span> -<span class="source-line-no">299</span><span id="line-299"> }</span> -<span class="source-line-no">300</span><span id="line-300"></span> -<span class="source-line-no">301</span><span id="line-301"> /**</span> -<span class="source-line-no">302</span><span id="line-302"> * Creates a parser for the given {@link File}.</span> -<span class="source-line-no">303</span><span id="line-303"> *</span> -<span class="source-line-no">304</span><span id="line-304"> * @param file</span> -<span class="source-line-no">305</span><span id="line-305"> * a CSV file. Must not be null.</span> -<span class="source-line-no">306</span><span id="line-306"> * @param charset</span> -<span class="source-line-no">307</span><span id="line-307"> * The Charset to decode the given file.</span> -<span class="source-line-no">308</span><span id="line-308"> * @param format</span> -<span class="source-line-no">309</span><span id="line-309"> * the CSVFormat used for CSV parsing. Must not be null.</span> -<span class="source-line-no">310</span><span id="line-310"> * @return a new parser</span> -<span class="source-line-no">311</span><span id="line-311"> * @throws IllegalArgumentException</span> -<span class="source-line-no">312</span><span id="line-312"> * If the parameters of the format are inconsistent or if either file or format are null.</span> -<span class="source-line-no">313</span><span id="line-313"> * @throws IOException</span> -<span class="source-line-no">314</span><span id="line-314"> * If an I/O error occurs</span> -<span class="source-line-no">315</span><span id="line-315"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">316</span><span id="line-316"> */</span> -<span class="source-line-no">317</span><span id="line-317"> public static CSVParser parse(final File file, final Charset charset, final CSVFormat format) throws IOException {</span> -<span class="source-line-no">318</span><span id="line-318"> Objects.requireNonNull(file, "file");</span> -<span class="source-line-no">319</span><span id="line-319"> return parse(file.toPath(), charset, format);</span> -<span class="source-line-no">320</span><span id="line-320"> }</span> -<span class="source-line-no">321</span><span id="line-321"></span> -<span class="source-line-no">322</span><span id="line-322"> /**</span> -<span class="source-line-no">323</span><span id="line-323"> * Creates a CSV parser using the given {@link CSVFormat}.</span> -<span class="source-line-no">324</span><span id="line-324"> *</span> -<span class="source-line-no">325</span><span id="line-325"> * <p></span> -<span class="source-line-no">326</span><span id="line-326"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> -<span class="source-line-no">327</span><span id="line-327"> * unless you close the {@code reader}.</span> -<span class="source-line-no">328</span><span id="line-328"> * </p></span> -<span class="source-line-no">329</span><span id="line-329"> *</span> -<span class="source-line-no">330</span><span id="line-330"> * @param inputStream</span> -<span class="source-line-no">331</span><span id="line-331"> * an InputStream containing CSV-formatted input. Must not be null.</span> -<span class="source-line-no">332</span><span id="line-332"> * @param charset</span> -<span class="source-line-no">333</span><span id="line-333"> * The Charset to decode the given file.</span> -<span class="source-line-no">334</span><span id="line-334"> * @param format</span> -<span class="source-line-no">335</span><span id="line-335"> * the CSVFormat used for CSV parsing. Must not be null.</span> -<span class="source-line-no">336</span><span id="line-336"> * @return a new CSVParser configured with the given reader and format.</span> -<span class="source-line-no">337</span><span id="line-337"> * @throws IllegalArgumentException</span> -<span class="source-line-no">338</span><span id="line-338"> * If the parameters of the format are inconsistent or if either reader or format are null.</span> -<span class="source-line-no">339</span><span id="line-339"> * @throws IOException</span> -<span class="source-line-no">340</span><span id="line-340"> * If there is a problem reading the header or skipping the first record</span> -<span class="source-line-no">341</span><span id="line-341"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">342</span><span id="line-342"> * @since 1.5</span> -<span class="source-line-no">343</span><span id="line-343"> */</span> -<span class="source-line-no">344</span><span id="line-344"> @SuppressWarnings("resource")</span> -<span class="source-line-no">345</span><span id="line-345"> public static CSVParser parse(final InputStream inputStream, final Charset charset, final CSVFormat format)</span> -<span class="source-line-no">346</span><span id="line-346"> throws IOException {</span> -<span class="source-line-no">347</span><span id="line-347"> Objects.requireNonNull(inputStream, "inputStream");</span> -<span class="source-line-no">348</span><span id="line-348"> Objects.requireNonNull(format, "format");</span> -<span class="source-line-no">349</span><span id="line-349"> return parse(new InputStreamReader(inputStream, charset), format);</span> +<span class="source-line-no">052</span><span id="line-52">import org.apache.commons.io.Charsets;</span> +<span class="source-line-no">053</span><span id="line-53">import org.apache.commons.io.build.AbstractStreamBuilder;</span> +<span class="source-line-no">054</span><span id="line-54">import org.apache.commons.io.function.Uncheck;</span> +<span class="source-line-no">055</span><span id="line-55"></span> +<span class="source-line-no">056</span><span id="line-56">/**</span> +<span class="source-line-no">057</span><span id="line-57"> * Parses CSV files according to the specified format.</span> +<span class="source-line-no">058</span><span id="line-58"> *</span> +<span class="source-line-no">059</span><span id="line-59"> * Because CSV appears in many different dialects, the parser supports many formats by allowing the</span> +<span class="source-line-no">060</span><span id="line-60"> * specification of a {@link CSVFormat}.</span> +<span class="source-line-no">061</span><span id="line-61"> *</span> +<span class="source-line-no">062</span><span id="line-62"> * The parser works record-wise. It is not possible to go back, once a record has been parsed from the input stream.</span> +<span class="source-line-no">063</span><span id="line-63"> *</span> +<span class="source-line-no">064</span><span id="line-64"> * <h2>Creating instances</h2></span> +<span class="source-line-no">065</span><span id="line-65"> * <p></span> +<span class="source-line-no">066</span><span id="line-66"> * There are several static factory methods that can be used to create instances for various types of resources:</span> +<span class="source-line-no">067</span><span id="line-67"> * </p></span> +<span class="source-line-no">068</span><span id="line-68"> * <ul></span> +<span class="source-line-no">069</span><span id="line-69"> * <li>{@link #parse(java.io.File, Charset, CSVFormat)}</li></span> +<span class="source-line-no">070</span><span id="line-70"> * <li>{@link #parse(String, CSVFormat)}</li></span> +<span class="source-line-no">071</span><span id="line-71"> * <li>{@link #parse(java.net.URL, java.nio.charset.Charset, CSVFormat)}</li></span> +<span class="source-line-no">072</span><span id="line-72"> * </ul></span> +<span class="source-line-no">073</span><span id="line-73"> * <p></span> +<span class="source-line-no">074</span><span id="line-74"> * Alternatively parsers can also be created by passing a {@link Reader} directly to the sole constructor.</span> +<span class="source-line-no">075</span><span id="line-75"> *</span> +<span class="source-line-no">076</span><span id="line-76"> * For those who like fluent APIs, parsers can be created using {@link CSVFormat#parse(java.io.Reader)} as a shortcut:</span> +<span class="source-line-no">077</span><span id="line-77"> * </p></span> +<span class="source-line-no">078</span><span id="line-78"> * <pre></span> +<span class="source-line-no">079</span><span id="line-79"> * for (CSVRecord record : CSVFormat.EXCEL.parse(in)) {</span> +<span class="source-line-no">080</span><span id="line-80"> * ...</span> +<span class="source-line-no">081</span><span id="line-81"> * }</span> +<span class="source-line-no">082</span><span id="line-82"> * </pre></span> +<span class="source-line-no">083</span><span id="line-83"> *</span> +<span class="source-line-no">084</span><span id="line-84"> * <h2>Parsing record wise</h2></span> +<span class="source-line-no">085</span><span id="line-85"> * <p></span> +<span class="source-line-no">086</span><span id="line-86"> * To parse a CSV input from a file, you write:</span> +<span class="source-line-no">087</span><span id="line-87"> * </p></span> +<span class="source-line-no">088</span><span id="line-88"> *</span> +<span class="source-line-no">089</span><span id="line-89"> * <pre>{@code</span> +<span class="source-line-no">090</span><span id="line-90"> * File csvData = new File("/path/to/csv");</span> +<span class="source-line-no">091</span><span id="line-91"> * CSVParser parser = CSVParser.parse(csvData, CSVFormat.RFC4180);</span> +<span class="source-line-no">092</span><span id="line-92"> * for (CSVRecord csvRecord : parser) {</span> +<span class="source-line-no">093</span><span id="line-93"> * ...</span> +<span class="source-line-no">094</span><span id="line-94"> * }}</span> +<span class="source-line-no">095</span><span id="line-95"> * </pre></span> +<span class="source-line-no">096</span><span id="line-96"> *</span> +<span class="source-line-no">097</span><span id="line-97"> * <p></span> +<span class="source-line-no">098</span><span id="line-98"> * This will read the parse the contents of the file using the</span> +<span class="source-line-no">099</span><span id="line-99"> * <a href="https://tools.ietf.org/html/rfc4180" target="_blank">RFC 4180</a> format.</span> +<span class="source-line-no">100</span><span id="line-100"> * </p></span> +<span class="source-line-no">101</span><span id="line-101"> *</span> +<span class="source-line-no">102</span><span id="line-102"> * <p></span> +<span class="source-line-no">103</span><span id="line-103"> * To parse CSV input in a format like Excel, you write:</span> +<span class="source-line-no">104</span><span id="line-104"> * </p></span> +<span class="source-line-no">105</span><span id="line-105"> *</span> +<span class="source-line-no">106</span><span id="line-106"> * <pre></span> +<span class="source-line-no">107</span><span id="line-107"> * CSVParser parser = CSVParser.parse(csvData, CSVFormat.EXCEL);</span> +<span class="source-line-no">108</span><span id="line-108"> * for (CSVRecord csvRecord : parser) {</span> +<span class="source-line-no">109</span><span id="line-109"> * ...</span> +<span class="source-line-no">110</span><span id="line-110"> * }</span> +<span class="source-line-no">111</span><span id="line-111"> * </pre></span> +<span class="source-line-no">112</span><span id="line-112"> *</span> +<span class="source-line-no">113</span><span id="line-113"> * <p></span> +<span class="source-line-no">114</span><span id="line-114"> * If the predefined formats don't match the format at hand, custom formats can be defined. More information about</span> +<span class="source-line-no">115</span><span id="line-115"> * customizing CSVFormats is available in {@link CSVFormat CSVFormat Javadoc}.</span> +<span class="source-line-no">116</span><span id="line-116"> * </p></span> +<span class="source-line-no">117</span><span id="line-117"> *</span> +<span class="source-line-no">118</span><span id="line-118"> * <h2>Parsing into memory</h2></span> +<span class="source-line-no">119</span><span id="line-119"> * <p></span> +<span class="source-line-no">120</span><span id="line-120"> * If parsing record-wise is not desired, the contents of the input can be read completely into memory.</span> +<span class="source-line-no">121</span><span id="line-121"> * </p></span> +<span class="source-line-no">122</span><span id="line-122"> *</span> +<span class="source-line-no">123</span><span id="line-123"> * <pre>{@code</span> +<span class="source-line-no">124</span><span id="line-124"> * Reader in = new StringReader("a;b\nc;d");</span> +<span class="source-line-no">125</span><span id="line-125"> * CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);</span> +<span class="source-line-no">126</span><span id="line-126"> * List<CSVRecord> list = parser.getRecords();</span> +<span class="source-line-no">127</span><span id="line-127"> * }</pre></span> +<span class="source-line-no">128</span><span id="line-128"> *</span> +<span class="source-line-no">129</span><span id="line-129"> * <p></span> +<span class="source-line-no">130</span><span id="line-130"> * There are two constraints that have to be kept in mind:</span> +<span class="source-line-no">131</span><span id="line-131"> * </p></span> +<span class="source-line-no">132</span><span id="line-132"> *</span> +<span class="source-line-no">133</span><span id="line-133"> * <ol></span> +<span class="source-line-no">134</span><span id="line-134"> * <li>Parsing into memory starts at the current position of the parser. If you have already parsed records from</span> +<span class="source-line-no">135</span><span id="line-135"> * the input, those records will not end up in the in-memory representation of your CSV data.</li></span> +<span class="source-line-no">136</span><span id="line-136"> * <li>Parsing into memory may consume a lot of system resources depending on the input. For example, if you're</span> +<span class="source-line-no">137</span><span id="line-137"> * parsing a 150MB file of CSV data the contents will be read completely into memory.</li></span> +<span class="source-line-no">138</span><span id="line-138"> * </ol></span> +<span class="source-line-no">139</span><span id="line-139"> *</span> +<span class="source-line-no">140</span><span id="line-140"> * <h2>Notes</h2></span> +<span class="source-line-no">141</span><span id="line-141"> * <p></span> +<span class="source-line-no">142</span><span id="line-142"> * The internal parser state is completely covered by the format and the reader state.</span> +<span class="source-line-no">143</span><span id="line-143"> * </p></span> +<span class="source-line-no">144</span><span id="line-144"> *</span> +<span class="source-line-no">145</span><span id="line-145"> * @see <a href="package-summary.html">package documentation for more details</a></span> +<span class="source-line-no">146</span><span id="line-146"> */</span> +<span class="source-line-no">147</span><span id="line-147">public final class CSVParser implements Iterable<CSVRecord>, Closeable {</span> +<span class="source-line-no">148</span><span id="line-148"></span> +<span class="source-line-no">149</span><span id="line-149"> /**</span> +<span class="source-line-no">150</span><span id="line-150"> * Builds a new {@link CSVParser}.</span> +<span class="source-line-no">151</span><span id="line-151"> *</span> +<span class="source-line-no">152</span><span id="line-152"> * @since 1.13.0</span> +<span class="source-line-no">153</span><span id="line-153"> */</span> +<span class="source-line-no">154</span><span id="line-154"> public static class Builder extends AbstractStreamBuilder<CSVParser, Builder> {</span> +<span class="source-line-no">155</span><span id="line-155"></span> +<span class="source-line-no">156</span><span id="line-156"> private CSVFormat format;</span> +<span class="source-line-no">157</span><span id="line-157"> private long characterOffset;</span> +<span class="source-line-no">158</span><span id="line-158"> private long recordNumber = 1;</span> +<span class="source-line-no">159</span><span id="line-159"> private boolean trackBytes;</span> +<span class="source-line-no">160</span><span id="line-160"></span> +<span class="source-line-no">161</span><span id="line-161"> /**</span> +<span class="source-line-no">162</span><span id="line-162"> * Constructs a new instance.</span> +<span class="source-line-no">163</span><span id="line-163"> */</span> +<span class="source-line-no">164</span><span id="line-164"> protected Builder() {</span> +<span class="source-line-no">165</span><span id="line-165"> // empty</span> +<span class="source-line-no">166</span><span id="line-166"> }</span> +<span class="source-line-no">167</span><span id="line-167"></span> +<span class="source-line-no">168</span><span id="line-168"> @SuppressWarnings("resource")</span> +<span class="source-line-no">169</span><span id="line-169"> @Override</span> +<span class="source-line-no">170</span><span id="line-170"> public CSVParser get() throws IOException {</span> +<span class="source-line-no">171</span><span id="line-171"> return new CSVParser(getReader(), format != null ? format : CSVFormat.DEFAULT, characterOffset, recordNumber, getCharset(), trackBytes);</span> +<span class="source-line-no">172</span><span id="line-172"> }</span> +<span class="source-line-no">173</span><span id="line-173"></span> +<span class="source-line-no">174</span><span id="line-174"> /**</span> +<span class="source-line-no">175</span><span id="line-175"> * Sets the lexer offset when the parser does not start parsing at the beginning of the source.</span> +<span class="source-line-no">176</span><span id="line-176"> *</span> +<span class="source-line-no">177</span><span id="line-177"> * @param characterOffset the lexer offset.</span> +<span class="source-line-no">178</span><span id="line-178"> * @return this instance.</span> +<span class="source-line-no">179</span><span id="line-179"> */</span> +<span class="source-line-no">180</span><span id="line-180"> public Builder setCharacterOffset(final long characterOffset) {</span> +<span class="source-line-no">181</span><span id="line-181"> this.characterOffset = characterOffset;</span> +<span class="source-line-no">182</span><span id="line-182"> return asThis();</span> +<span class="source-line-no">183</span><span id="line-183"> }</span> +<span class="source-line-no">184</span><span id="line-184"></span> +<span class="source-line-no">185</span><span id="line-185"> /**</span> +<span class="source-line-no">186</span><span id="line-186"> * Sets the CSV format. A copy of the given format is kept.</span> +<span class="source-line-no">187</span><span id="line-187"> *</span> +<span class="source-line-no">188</span><span id="line-188"> * @param format the CSV format, {@code null} resets to {@link CSVFormat#DEFAULT}.</span> +<span class="source-line-no">189</span><span id="line-189"> * @return this instance.</span> +<span class="source-line-no">190</span><span id="line-190"> */</span> +<span class="source-line-no">191</span><span id="line-191"> public Builder setFormat(final CSVFormat format) {</span> +<span class="source-line-no">192</span><span id="line-192"> this.format = CSVFormat.copy(format);</span> +<span class="source-line-no">193</span><span id="line-193"> return asThis();</span> +<span class="source-line-no">194</span><span id="line-194"> }</span> +<span class="source-line-no">195</span><span id="line-195"></span> +<span class="source-line-no">196</span><span id="line-196"> /**</span> +<span class="source-line-no">197</span><span id="line-197"> * Sets the next record number to assign, defaults to {@code 1}.</span> +<span class="source-line-no">198</span><span id="line-198"> *</span> +<span class="source-line-no">199</span><span id="line-199"> * @param recordNumber the next record number to assign.</span> +<span class="source-line-no">200</span><span id="line-200"> * @return this instance.</span> +<span class="source-line-no">201</span><span id="line-201"> */</span> +<span class="source-line-no">202</span><span id="line-202"> public Builder setRecordNumber(final long recordNumber) {</span> +<span class="source-line-no">203</span><span id="line-203"> this.recordNumber = recordNumber;</span> +<span class="source-line-no">204</span><span id="line-204"> return asThis();</span> +<span class="source-line-no">205</span><span id="line-205"> }</span> +<span class="source-line-no">206</span><span id="line-206"></span> +<span class="source-line-no">207</span><span id="line-207"> /**</span> +<span class="source-line-no">208</span><span id="line-208"> * Sets whether to enable byte tracking for the parser.</span> +<span class="source-line-no">209</span><span id="line-209"> *</span> +<span class="source-line-no">210</span><span id="line-210"> * @param trackBytes {@code true} to enable byte tracking; {@code false} to disable it.</span> +<span class="source-line-no">211</span><span id="line-211"> * @return this instance.</span> +<span class="source-line-no">212</span><span id="line-212"> * @since 1.13.0</span> +<span class="source-line-no">213</span><span id="line-213"> */</span> +<span class="source-line-no">214</span><span id="line-214"> public Builder setTrackBytes(final boolean trackBytes) {</span> +<span class="source-line-no">215</span><span id="line-215"> this.trackBytes = trackBytes;</span> +<span class="source-line-no">216</span><span id="line-216"> return asThis();</span> +<span class="source-line-no">217</span><span id="line-217"> }</span> +<span class="source-line-no">218</span><span id="line-218"></span> +<span class="source-line-no">219</span><span id="line-219"> }</span> +<span class="source-line-no">220</span><span id="line-220"></span> +<span class="source-line-no">221</span><span id="line-221"> final class CSVRecordIterator implements Iterator<CSVRecord> {</span> +<span class="source-line-no">222</span><span id="line-222"> private CSVRecord current;</span> +<span class="source-line-no">223</span><span id="line-223"></span> +<span class="source-line-no">224</span><span id="line-224"> /**</span> +<span class="source-line-no">225</span><span id="line-225"> * Gets the next record or null at the end of stream or max rows read.</span> +<span class="source-line-no">226</span><span id="line-226"> *</span> +<span class="source-line-no">227</span><span id="line-227"> * @throws IOException on parse error or input read-failure</span> +<span class="source-line-no">228</span><span id="line-228"> * @throws CSVException on invalid input.</span> +<span class="source-line-no">229</span><span id="line-229"> * @return the next record, or {@code null} if the end of the stream has been reached.</span> +<span class="source-line-no">230</span><span id="line-230"> */</span> +<span class="source-line-no">231</span><span id="line-231"> private CSVRecord getNextRecord() {</span> +<span class="source-line-no">232</span><span id="line-232"> CSVRecord record = null;</span> +<span class="source-line-no">233</span><span id="line-233"> if (format.useRow(recordNumber + 1)) {</span> +<span class="source-line-no">234</span><span id="line-234"> record = Uncheck.get(CSVParser.this::nextRecord);</span> +<span class="source-line-no">235</span><span id="line-235"> }</span> +<span class="source-line-no">236</span><span id="line-236"> return record;</span> +<span class="source-line-no">237</span><span id="line-237"> }</span> +<span class="source-line-no">238</span><span id="line-238"></span> +<span class="source-line-no">239</span><span id="line-239"> @Override</span> +<span class="source-line-no">240</span><span id="line-240"> public boolean hasNext() {</span> +<span class="source-line-no">241</span><span id="line-241"> if (isClosed()) {</span> +<span class="source-line-no">242</span><span id="line-242"> return false;</span> +<span class="source-line-no">243</span><span id="line-243"> }</span> +<span class="source-line-no">244</span><span id="line-244"> if (current == null) {</span> +<span class="source-line-no">245</span><span id="line-245"> current = getNextRecord();</span> +<span class="source-line-no">246</span><span id="line-246"> }</span> +<span class="source-line-no">247</span><span id="line-247"> return current != null;</span> +<span class="source-line-no">248</span><span id="line-248"> }</span> +<span class="source-line-no">249</span><span id="line-249"></span> +<span class="source-line-no">250</span><span id="line-250"> @Override</span> +<span class="source-line-no">251</span><span id="line-251"> public CSVRecord next() {</span> +<span class="source-line-no">252</span><span id="line-252"> if (isClosed()) {</span> +<span class="source-line-no">253</span><span id="line-253"> throw new NoSuchElementException("CSVParser has been closed");</span> +<span class="source-line-no">254</span><span id="line-254"> }</span> +<span class="source-line-no">255</span><span id="line-255"> CSVRecord next = current;</span> +<span class="source-line-no">256</span><span id="line-256"> current = null;</span> +<span class="source-line-no">257</span><span id="line-257"> if (next == null) {</span> +<span class="source-line-no">258</span><span id="line-258"> // hasNext() wasn't called before</span> +<span class="source-line-no">259</span><span id="line-259"> next = getNextRecord();</span> +<span class="source-line-no">260</span><span id="line-260"> if (next == null) {</span> +<span class="source-line-no">261</span><span id="line-261"> throw new NoSuchElementException("No more CSV records available");</span> +<span class="source-line-no">262</span><span id="line-262"> }</span> +<span class="source-line-no">263</span><span id="line-263"> }</span> +<span class="source-line-no">264</span><span id="line-264"> return next;</span> +<span class="source-line-no">265</span><span id="line-265"> }</span> +<span class="source-line-no">266</span><span id="line-266"></span> +<span class="source-line-no">267</span><span id="line-267"> @Override</span> +<span class="source-line-no">268</span><span id="line-268"> public void remove() {</span> +<span class="source-line-no">269</span><span id="line-269"> throw new UnsupportedOperationException();</span> +<span class="source-line-no">270</span><span id="line-270"> }</span> +<span class="source-line-no">271</span><span id="line-271"> }</span> +<span class="source-line-no">272</span><span id="line-272"> /**</span> +<span class="source-line-no">273</span><span id="line-273"> * Header information based on name and position.</span> +<span class="source-line-no">274</span><span id="line-274"> */</span> +<span class="source-line-no">275</span><span id="line-275"> private static final class Headers {</span> +<span class="source-line-no">276</span><span id="line-276"></span> +<span class="source-line-no">277</span><span id="line-277"> /**</span> +<span class="source-line-no">278</span><span id="line-278"> * Header column positions (0-based)</span> +<span class="source-line-no">279</span><span id="line-279"> */</span> +<span class="source-line-no">280</span><span id="line-280"> final Map<String, Integer> headerMap;</span> +<span class="source-line-no">281</span><span id="line-281"></span> +<span class="source-line-no">282</span><span id="line-282"> /**</span> +<span class="source-line-no">283</span><span id="line-283"> * Header names in column order</span> +<span class="source-line-no">284</span><span id="line-284"> */</span> +<span class="source-line-no">285</span><span id="line-285"> final List<String> headerNames;</span> +<span class="source-line-no">286</span><span id="line-286"></span> +<span class="source-line-no">287</span><span id="line-287"> Headers(final Map<String, Integer> headerMap, final List<String> headerNames) {</span> +<span class="source-line-no">288</span><span id="line-288"> this.headerMap = headerMap;</span> +<span class="source-line-no">289</span><span id="line-289"> this.headerNames = headerNames;</span> +<span class="source-line-no">290</span><span id="line-290"> }</span> +<span class="source-line-no">291</span><span id="line-291"> }</span> +<span class="source-line-no">292</span><span id="line-292"></span> +<span class="source-line-no">293</span><span id="line-293"> /**</span> +<span class="source-line-no">294</span><span id="line-294"> * Creates a new builder.</span> +<span class="source-line-no">295</span><span id="line-295"> *</span> +<span class="source-line-no">296</span><span id="line-296"> * @return a new builder.</span> +<span class="source-line-no">297</span><span id="line-297"> * @since 1.13.0</span> +<span class="source-line-no">298</span><span id="line-298"> */</span> +<span class="source-line-no">299</span><span id="line-299"> public static Builder builder() {</span> +<span class="source-line-no">300</span><span id="line-300"> return new Builder();</span> +<span class="source-line-no">301</span><span id="line-301"> }</span> +<span class="source-line-no">302</span><span id="line-302"></span> +<span class="source-line-no">303</span><span id="line-303"> /**</span> +<span class="source-line-no">304</span><span id="line-304"> * Creates a parser for the given {@link File}.</span> +<span class="source-line-no">305</span><span id="line-305"> *</span> +<span class="source-line-no">306</span><span id="line-306"> * @param file</span> +<span class="source-line-no">307</span><span id="line-307"> * a CSV file. Must not be null.</span> +<span class="source-line-no">308</span><span id="line-308"> * @param charset</span> +<span class="source-line-no">309</span><span id="line-309"> * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.</span> +<span class="source-line-no">310</span><span id="line-310"> * @param format</span> +<span class="source-line-no">311</span><span id="line-311"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> +<span class="source-line-no">312</span><span id="line-312"> * @return a new parser</span> +<span class="source-line-no">313</span><span id="line-313"> * @throws IllegalArgumentException</span> +<span class="source-line-no">314</span><span id="line-314"> * If the parameters of the format are inconsistent.</span> +<span class="source-line-no">315</span><span id="line-315"> * @throws IOException</span> +<span class="source-line-no">316</span><span id="line-316"> * If an I/O error occurs</span> +<span class="source-line-no">317</span><span id="line-317"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">318</span><span id="line-318"> * @throws NullPointerException if {@code file} is {@code null}.</span> +<span class="source-line-no">319</span><span id="line-319"> */</span> +<span class="source-line-no">320</span><span id="line-320"> public static CSVParser parse(final File file, final Charset charset, final CSVFormat format) throws IOException {</span> +<span class="source-line-no">321</span><span id="line-321"> Objects.requireNonNull(file, "file");</span> +<span class="source-line-no">322</span><span id="line-322"> return parse(file.toPath(), charset, format);</span> +<span class="source-line-no">323</span><span id="line-323"> }</span> +<span class="source-line-no">324</span><span id="line-324"></span> +<span class="source-line-no">325</span><span id="line-325"> /**</span> +<span class="source-line-no">326</span><span id="line-326"> * Creates a CSV parser using the given {@link CSVFormat}.</span> +<span class="source-line-no">327</span><span id="line-327"> *</span> +<span class="source-line-no">328</span><span id="line-328"> * <p></span> +<span class="source-line-no">329</span><span id="line-329"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> +<span class="source-line-no">330</span><span id="line-330"> * unless you close the {@code reader}.</span> +<span class="source-line-no">331</span><span id="line-331"> * </p></span> +<span class="source-line-no">332</span><span id="line-332"> *</span> +<span class="source-line-no">333</span><span id="line-333"> * @param inputStream</span> +<span class="source-line-no">334</span><span id="line-334"> * an InputStream containing CSV-formatted input, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> +<span class="source-line-no">335</span><span id="line-335"> * @param charset</span> +<span class="source-line-no">336</span><span id="line-336"> * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.</span> +<span class="source-line-no">337</span><span id="line-337"> * @param format</span> +<span class="source-line-no">338</span><span id="line-338"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> +<span class="source-line-no">339</span><span id="line-339"> * @return a new CSVParser configured with the given reader and format.</span> +<span class="source-line-no">340</span><span id="line-340"> * @throws IllegalArgumentException</span> +<span class="source-line-no">341</span><span id="line-341"> * If the parameters of the format are inconsistent or if either reader or format are null.</span> +<span class="source-line-no">342</span><span id="line-342"> * @throws IOException</span> +<span class="source-line-no">343</span><span id="line-343"> * If there is a problem reading the header or skipping the first record</span> +<span class="source-line-no">344</span><span id="line-344"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">345</span><span id="line-345"> * @since 1.5</span> +<span class="source-line-no">346</span><span id="line-346"> */</span> +<span class="source-line-no">347</span><span id="line-347"> public static CSVParser parse(final InputStream inputStream, final Charset charset, final CSVFormat format)</span> +<span class="source-line-no">348</span><span id="line-348"> throws IOException {</span> +<span class="source-line-no">349</span><span id="line-349"> return parse(new InputStreamReader(inputStream, Charsets.toCharset(charset)), format);</span> <span class="source-line-no">350</span><span id="line-350"> }</span> <span class="source-line-no">351</span><span id="line-351"></span> <span class="source-line-no">352</span><span id="line-352"> /**</span> @@ -368,21 +368,21 @@ <span class="source-line-no">355</span><span id="line-355"> * @param path</span> <span class="source-line-no">356</span><span id="line-356"> * a CSV file. Must not be null.</span> <span class="source-line-no">357</span><span id="line-357"> * @param charset</span> -<span class="source-line-no">358</span><span id="line-358"> * The Charset to decode the given file.</span> +<span class="source-line-no">358</span><span id="line-358"> * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.</span> <span class="source-line-no">359</span><span id="line-359"> * @param format</span> -<span class="source-line-no">360</span><span id="line-360"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">360</span><span id="line-360"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> <span class="source-line-no">361</span><span id="line-361"> * @return a new parser</span> <span class="source-line-no">362</span><span id="line-362"> * @throws IllegalArgumentException</span> -<span class="source-line-no">363</span><span id="line-363"> * If the parameters of the format are inconsistent or if either file or format are null.</span> +<span class="source-line-no">363</span><span id="line-363"> * If the parameters of the format are inconsistent.</span> <span class="source-line-no">364</span><span id="line-364"> * @throws IOException</span> <span class="source-line-no">365</span><span id="line-365"> * If an I/O error occurs</span> -<span class="source-line-no">366</span><span id="line-366"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">367</span><span id="line-367"> * @since 1.5</span> -<span class="source-line-no">368</span><span id="line-368"> */</span> -<span class="source-line-no">369</span><span id="line-369"> @SuppressWarnings("resource")</span> -<span class="source-line-no">370</span><span id="line-370"> public static CSVParser parse(final Path path, final Charset charset, final CSVFormat format) throws IOException {</span> -<span class="source-line-no">371</span><span id="line-371"> Objects.requireNonNull(path, "path");</span> -<span class="source-line-no">372</span><span id="line-372"> Objects.requireNonNull(format, "format");</span> +<span class="source-line-no">366</span><span id="line-366"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">367</span><span id="line-367"> * @throws NullPointerException if {@code path} is {@code null}.</span> +<span class="source-line-no">368</span><span id="line-368"> * @since 1.5</span> +<span class="source-line-no">369</span><span id="line-369"> */</span> +<span class="source-line-no">370</span><span id="line-370"> @SuppressWarnings("resource")</span> +<span class="source-line-no">371</span><span id="line-371"> public static CSVParser parse(final Path path, final Charset charset, final CSVFormat format) throws IOException {</span> +<span class="source-line-no">372</span><span id="line-372"> Objects.requireNonNull(path, "path");</span> <span class="source-line-no">373</span><span id="line-373"> return parse(Files.newInputStream(path), charset, format);</span> <span class="source-line-no">374</span><span id="line-374"> }</span> <span class="source-line-no">375</span><span id="line-375"></span> @@ -397,13 +397,13 @@ <span class="source-line-no">384</span><span id="line-384"> * @param reader</span> <span class="source-line-no">385</span><span id="line-385"> * a Reader containing CSV-formatted input. Must not be null.</span> <span class="source-line-no">386</span><span id="line-386"> * @param format</span> -<span class="source-line-no">387</span><span id="line-387"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">387</span><span id="line-387"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> <span class="source-line-no">388</span><span id="line-388"> * @return a new CSVParser configured with the given reader and format.</span> <span class="source-line-no">389</span><span id="line-389"> * @throws IllegalArgumentException</span> <span class="source-line-no">390</span><span id="line-390"> * If the parameters of the format are inconsistent or if either reader or format are null.</span> <span class="source-line-no">391</span><span id="line-391"> * @throws IOException</span> <span class="source-line-no">392</span><span id="line-392"> * If there is a problem reading the header or skipping the first record</span> -<span class="source-line-no">393</span><span id="line-393"> * @throws CSVException Thrown on invalid input.</span> +<span class="source-line-no">393</span><span id="line-393"> * @throws CSVException Thrown on invalid CSV input data.</span> <span class="source-line-no">394</span><span id="line-394"> * @since 1.5</span> <span class="source-line-no">395</span><span id="line-395"> */</span> <span class="source-line-no">396</span><span id="line-396"> public static CSVParser parse(final Reader reader, final CSVFormat format) throws IOException {</span> @@ -416,17 +416,17 @@ <span class="source-line-no">403</span><span id="line-403"> * @param string</span> <span class="source-line-no">404</span><span id="line-404"> * a CSV string. Must not be null.</span> <span class="source-line-no">405</span><span id="line-405"> * @param format</span> -<span class="source-line-no">406</span><span id="line-406"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">406</span><span id="line-406"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> <span class="source-line-no">407</span><span id="line-407"> * @return a new parser</span> <span class="source-line-no">408</span><span id="line-408"> * @throws IllegalArgumentException</span> -<span class="source-line-no">409</span><span id="line-409"> * If the parameters of the format are inconsistent or if either string or format are null.</span> +<span class="source-line-no">409</span><span id="line-409"> * If the parameters of the format are inconsistent.</span> <span class="source-line-no">410</span><span id="line-410"> * @throws IOException</span> <span class="source-line-no">411</span><span id="line-411"> * If an I/O error occurs</span> -<span class="source-line-no">412</span><span id="line-412"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">413</span><span id="line-413"> */</span> -<span class="source-line-no">414</span><span id="line-414"> public static CSVParser parse(final String string, final CSVFormat format) throws IOException {</span> -<span class="source-line-no">415</span><span id="line-415"> Objects.requireNonNull(string, "string");</span> -<span class="source-line-no">416</span><span id="line-416"> Objects.requireNonNull(format, "format");</span> +<span class="source-line-no">412</span><span id="line-412"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">413</span><span id="line-413"> * @throws NullPointerException if {@code string} is {@code null}.</span> +<span class="source-line-no">414</span><span id="line-414"> */</span> +<span class="source-line-no">415</span><span id="line-415"> public static CSVParser parse(final String string, final CSVFormat format) throws IOException {</span> +<span class="source-line-no">416</span><span id="line-416"> Objects.requireNonNull(string, "string");</span> <span class="source-line-no">417</span><span id="line-417"> return parse(new StringReader(string), format);</span> <span class="source-line-no">418</span><span id="line-418"> }</span> <span class="source-line-no">419</span><span id="line-419"></span> @@ -441,106 +441,106 @@ <span class="source-line-no">428</span><span id="line-428"> * @param url</span> <span class="source-line-no">429</span><span id="line-429"> * a URL. Must not be null.</span> <span class="source-line-no">430</span><span id="line-430"> * @param charset</span> -<span class="source-line-no">431</span><span id="line-431"> * the charset for the resource. Must not be null.</span> +<span class="source-line-no">431</span><span id="line-431"> * the charset for the resource, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.</span> <span class="source-line-no">432</span><span id="line-432"> * @param format</span> -<span class="source-line-no">433</span><span id="line-433"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">433</span><span id="line-433"> * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.</span> <span class="source-line-no">434</span><span id="line-434"> * @return a new parser</span> <span class="source-line-no">435</span><span id="line-435"> * @throws IllegalArgumentException</span> -<span class="source-line-no">436</span><span id="line-436"> * If the parameters of the format are inconsistent or if either url, charset or format are null.</span> +<span class="source-line-no">436</span><span id="line-436"> * If the parameters of the format are inconsistent.</span> <span class="source-line-no">437</span><span id="line-437"> * @throws IOException</span> <span class="source-line-no">438</span><span id="line-438"> * If an I/O error occurs</span> -<span class="source-line-no">439</span><span id="line-439"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">440</span><span id="line-440"> */</span> -<span class="source-line-no">441</span><span id="line-441"> @SuppressWarnings("resource")</span> -<span class="source-line-no">442</span><span id="line-442"> public static CSVParser parse(final URL url, final Charset charset, final CSVFormat format) throws IOException {</span> -<span class="source-line-no">443</span><span id="line-443"> Objects.requireNonNull(url, "url");</span> -<span class="source-line-no">444</span><span id="line-444"> return parse(url.openStream(), charset, format);</span> -<span class="source-line-no">445</span><span id="line-445"> }</span> -<span class="source-line-no">446</span><span id="line-446"></span> -<span class="source-line-no">447</span><span id="line-447"> private String headerComment;</span> -<span class="source-line-no">448</span><span id="line-448"></span> -<span class="source-line-no">449</span><span id="line-449"> private String trailerComment;</span> -<span class="source-line-no">450</span><span id="line-450"></span> -<span class="source-line-no">451</span><span id="line-451"> private final CSVFormat format;</span> -<span class="source-line-no">452</span><span id="line-452"></span> -<span class="source-line-no">453</span><span id="line-453"> private final Headers headers;</span> -<span class="source-line-no">454</span><span id="line-454"></span> -<span class="source-line-no">455</span><span id="line-455"> private final Lexer lexer;</span> -<span class="source-line-no">456</span><span id="line-456"></span> -<span class="source-line-no">457</span><span id="line-457"> private final CSVRecordIterator csvRecordIterator;</span> -<span class="source-line-no">458</span><span id="line-458"></span> -<span class="source-line-no">459</span><span id="line-459"> /** A record buffer for getRecord(). Grows as necessary and is reused. */</span> -<span class="source-line-no">460</span><span id="line-460"> private final List<String> recordList = new ArrayList<>();</span> -<span class="source-line-no">461</span><span id="line-461"></span> -<span class="source-line-no">462</span><span id="line-462"> /**</span> -<span class="source-line-no">463</span><span id="line-463"> * The next record number to assign.</span> -<span class="source-line-no">464</span><span id="line-464"> */</span> -<span class="source-line-no">465</span><span id="line-465"> private long recordNumber;</span> -<span class="source-line-no">466</span><span id="line-466"></span> -<span class="source-line-no">467</span><span id="line-467"> /**</span> -<span class="source-line-no">468</span><span id="line-468"> * Lexer offset when the parser does not start parsing at the beginning of the source. Usually used in combination</span> -<span class="source-line-no">469</span><span id="line-469"> * with {@link #recordNumber}.</span> -<span class="source-line-no">470</span><span id="line-470"> */</span> -<span class="source-line-no">471</span><span id="line-471"> private final long characterOffset;</span> -<span class="source-line-no">472</span><span id="line-472"></span> -<span class="source-line-no">473</span><span id="line-473"> private final Token reusableToken = new Token();</span> -<span class="source-line-no">474</span><span id="line-474"></span> -<span class="source-line-no">475</span><span id="line-475"> /**</span> -<span class="source-line-no">476</span><span id="line-476"> * Constructs a new instance using the given {@link CSVFormat}</span> -<span class="source-line-no">477</span><span id="line-477"> *</span> -<span class="source-line-no">478</span><span id="line-478"> * <p></span> -<span class="source-line-no">479</span><span id="line-479"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> -<span class="source-line-no">480</span><span id="line-480"> * unless you close the {@code reader}.</span> -<span class="source-line-no">481</span><span id="line-481"> * </p></span> -<span class="source-line-no">482</span><span id="line-482"> *</span> -<span class="source-line-no">483</span><span id="line-483"> * @param reader</span> -<span class="source-line-no">484</span><span id="line-484"> * a Reader containing CSV-formatted input. Must not be null.</span> -<span class="source-line-no">485</span><span id="line-485"> * @param format</span> -<span class="source-line-no">486</span><span id="line-486"> * the CSVFormat used for CSV parsing. Must not be null.</span> -<span class="source-line-no">487</span><span id="line-487"> * @throws IllegalArgumentException</span> -<span class="source-line-no">488</span><span id="line-488"> * If the parameters of the format are inconsistent or if either reader or format are null.</span> -<span class="source-line-no">489</span><span id="line-489"> * @throws IOException</span> -<span class="source-line-no">490</span><span id="line-490"> * If there is a problem reading the header or skipping the first record</span> -<span class="source-line-no">491</span><span id="line-491"> * @throws CSVException Thrown on invalid input.</span> -<span class="source-line-no">492</span><span id="line-492"> * @deprecated Will be removed in the next major version, use {@link Builder#get()}.</span> -<span class="source-line-no">493</span><span id="line-493"> */</span> -<span class="source-line-no">494</span><span id="line-494"> @Deprecated</span> -<span class="source-line-no">495</span><span id="line-495"> public CSVParser(final Reader reader, final CSVFormat format) throws IOException {</span> -<span class="source-line-no">496</span><span id="line-496"> this(reader, format, 0, 1);</span> -<span class="source-line-no">497</span><span id="line-497"> }</span> -<span class="source-line-no">498</span><span id="line-498"></span> -<span class="source-line-no">499</span><span id="line-499"> /**</span> -<span class="source-line-no">500</span><span id="line-500"> * Constructs a new instance using the given {@link CSVFormat}</span> -<span class="source-line-no">501</span><span id="line-501"> *</span> -<span class="source-line-no">502</span><span id="line-502"> * <p></span> -<span class="source-line-no">503</span><span id="line-503"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> -<span class="source-line-no">504</span><span id="line-504"> * unless you close the {@code reader}.</span> -<span class="source-line-no">505</span><span id="line-505"> * </p></span> -<span class="source-line-no">506</span><span id="line-506"> *</span> -<span class="source-line-no">507</span><span id="line-507"> * @param reader</span> -<span class="source-line-no">508</span><span id="line-508"> * a Reader containing CSV-formatted input. Must not be null.</span> -<span class="source-line-no">509</span><span id="line-509"> * @param format</span> -<span class="source-line-no">510</span><span id="line-510"> * the CSVFormat used for CSV parsing. Must not be null.</span> -<span class="source-line-no">511</span><span id="line-511"> * @param characterOffset</span> -<span class="source-line-no">512</span><span id="line-512"> * Lexer offset when the parser does not start parsing at the beginning of the source.</span> -<span class="source-line-no">513</span><span id="line-513"> * @param recordNumber</span> -<span class="source-line-no">514</span><span id="line-514"> * The next record number to assign.</span> -<span class="source-line-no">515</span><span id="line-515"> * @throws IllegalArgumentException</span> -<span class="source-line-no">516</span><span id="line-516"> * If the parameters of the format are inconsistent or if either the reader or format is null.</span> -<span class="source-line-no">517</span><span id="line-517"> * @throws IOException</span> -<span class="source-line-no">518</span><span id="line-518"> * if there is a problem reading the header or skipping the first record</span> -<span class="source-line-no">519</span><span id="line-519"> * @throws CSVException on invalid input.</span> -<span class="source-line-no">520</span><span id="line-520"> * @since 1.1</span> -<span class="source-line-no">521</span><span id="line-521"> * @deprecated Will be private in the next major version, use {@link Builder#get()}.</span> -<span class="source-line-no">522</span><span id="line-522"> */</span> -<span class="source-line-no">523</span><span id="line-523"> @Deprecated</span> -<span class="source-line-no">524</span><span id="line-524"> public CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber)</span> -<span class="source-line-no">525</span><span id="line-525"> throws IOException {</span> -<span class="source-line-no">526</span><span id="line-526"> this(reader, format, characterOffset, recordNumber, null, false);</span> -<span class="source-line-no">527</span><span id="line-527"> }</span> +<span class="source-line-no">439</span><span id="line-439"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">440</span><span id="line-440"> * @throws NullPointerException if {@code url} is {@code null}.</span> +<span class="source-line-no">441</span><span id="line-441"> */</span> +<span class="source-line-no">442</span><span id="line-442"> @SuppressWarnings("resource")</span> +<span class="source-line-no">443</span><span id="line-443"> public static CSVParser parse(final URL url, final Charset charset, final CSVFormat format) throws IOException {</span> +<span class="source-line-no">444</span><span id="line-444"> Objects.requireNonNull(url, "url");</span> +<span class="source-line-no">445</span><span id="line-445"> return parse(url.openStream(), charset, format);</span> +<span class="source-line-no">446</span><span id="line-446"> }</span> +<span class="source-line-no">447</span><span id="line-447"></span> +<span class="source-line-no">448</span><span id="line-448"> private String headerComment;</span> +<span class="source-line-no">449</span><span id="line-449"></span> +<span class="source-line-no">450</span><span id="line-450"> private String trailerComment;</span> +<span class="source-line-no">451</span><span id="line-451"></span> +<span class="source-line-no">452</span><span id="line-452"> private final CSVFormat format;</span> +<span class="source-line-no">453</span><span id="line-453"></span> +<span class="source-line-no">454</span><span id="line-454"> private final Headers headers;</span> +<span class="source-line-no">455</span><span id="line-455"></span> +<span class="source-line-no">456</span><span id="line-456"> private final Lexer lexer;</span> +<span class="source-line-no">457</span><span id="line-457"></span> +<span class="source-line-no">458</span><span id="line-458"> private final CSVRecordIterator csvRecordIterator;</span> +<span class="source-line-no">459</span><span id="line-459"></span> +<span class="source-line-no">460</span><span id="line-460"> /** A record buffer for getRecord(). Grows as necessary and is reused. */</span> +<span class="source-line-no">461</span><span id="line-461"> private final List<String> recordList = new ArrayList<>();</span> +<span class="source-line-no">462</span><span id="line-462"></span> +<span class="source-line-no">463</span><span id="line-463"> /**</span> +<span class="source-line-no">464</span><span id="line-464"> * The next record number to assign.</span> +<span class="source-line-no">465</span><span id="line-465"> */</span> +<span class="source-line-no">466</span><span id="line-466"> private long recordNumber;</span> +<span class="source-line-no">467</span><span id="line-467"></span> +<span class="source-line-no">468</span><span id="line-468"> /**</span> +<span class="source-line-no">469</span><span id="line-469"> * Lexer offset when the parser does not start parsing at the beginning of the source. Usually used in combination</span> +<span class="source-line-no">470</span><span id="line-470"> * with {@link #recordNumber}.</span> +<span class="source-line-no">471</span><span id="line-471"> */</span> +<span class="source-line-no">472</span><span id="line-472"> private final long characterOffset;</span> +<span class="source-line-no">473</span><span id="line-473"></span> +<span class="source-line-no">474</span><span id="line-474"> private final Token reusableToken = new Token();</span> +<span class="source-line-no">475</span><span id="line-475"></span> +<span class="source-line-no">476</span><span id="line-476"> /**</span> +<span class="source-line-no">477</span><span id="line-477"> * Constructs a new instance using the given {@link CSVFormat}.</span> +<span class="source-line-no">478</span><span id="line-478"> *</span> +<span class="source-line-no">479</span><span id="line-479"> * <p></span> +<span class="source-line-no">480</span><span id="line-480"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> +<span class="source-line-no">481</span><span id="line-481"> * unless you close the {@code reader}.</span> +<span class="source-line-no">482</span><span id="line-482"> * </p></span> +<span class="source-line-no">483</span><span id="line-483"> *</span> +<span class="source-line-no">484</span><span id="line-484"> * @param reader</span> +<span class="source-line-no">485</span><span id="line-485"> * a Reader containing CSV-formatted input. Must not be null.</span> +<span class="source-line-no">486</span><span id="line-486"> * @param format</span> +<span class="source-line-no">487</span><span id="line-487"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">488</span><span id="line-488"> * @throws IllegalArgumentException</span> +<span class="source-line-no">489</span><span id="line-489"> * If the parameters of the format are inconsistent or if either reader or format are null.</span> +<span class="source-line-no">490</span><span id="line-490"> * @throws IOException</span> +<span class="source-line-no">491</span><span id="line-491"> * If there is a problem reading the header or skipping the first record</span> +<span class="source-line-no">492</span><span id="line-492"> * @throws CSVException Thrown on invalid CSV input data.</span> +<span class="source-line-no">493</span><span id="line-493"> * @deprecated Will be removed in the next major version, use {@link Builder#get()}.</span> +<span class="source-line-no">494</span><span id="line-494"> */</span> +<span class="source-line-no">495</span><span id="line-495"> @Deprecated</span> +<span class="source-line-no">496</span><span id="line-496"> public CSVParser(final Reader reader, final CSVFormat format) throws IOException {</span> +<span class="source-line-no">497</span><span id="line-497"> this(reader, format, 0, 1);</span> +<span class="source-line-no">498</span><span id="line-498"> }</span> +<span class="source-line-no">499</span><span id="line-499"></span> +<span class="source-line-no">500</span><span id="line-500"> /**</span> +<span class="source-line-no">501</span><span id="line-501"> * Constructs a new instance using the given {@link CSVFormat}.</span> +<span class="source-line-no">502</span><span id="line-502"> *</span> +<span class="source-line-no">503</span><span id="line-503"> * <p></span> +<span class="source-line-no">504</span><span id="line-504"> * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser,</span> +<span class="source-line-no">505</span><span id="line-505"> * unless you close the {@code reader}.</span> +<span class="source-line-no">506</span><span id="line-506"> * </p></span> +<span class="source-line-no">507</span><span id="line-507"> *</span> +<span class="source-line-no">508</span><span id="line-508"> * @param reader</span> +<span class="source-line-no">509</span><span id="line-509"> * a Reader containing CSV-formatted input. Must not be null.</span> +<span class="source-line-no">510</span><span id="line-510"> * @param format</span> +<span class="source-line-no">511</span><span id="line-511"> * the CSVFormat used for CSV parsing. Must not be null.</span> +<span class="source-line-no">512</span><span id="line-512"> * @param characterOffset</span> +<span class="source-line-no">513</span><span id="line-513"> * Lexer offset when the parser does not start parsing at the beginning of the source.</span> +<span class="source-line-no">514</span><span id="line-514"> * @param recordNumber</span> +<span class="source-line-no">515</span><span id="line-515"> * The next record number to assign.</span> +<span class="source-line-no">516</span><span id="line-516"> * @throws IllegalArgumentException</span> +<span class="source-line-no">517</span><span id="line-517"> * If the parameters of the format are inconsistent or if either the reader or format is null.</span> +<span class="source-line-no">518</span><span id="line-518"> * @throws IOException</span>
[... 694 lines stripped ...]