Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.Builder.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.Builder.html (original) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.Builder.html Mon Jan 13 14:52:07 2025 @@ -1,34 +1,30 @@ <!DOCTYPE HTML> <html lang> <head> -<!-- Generated by javadoc (17) --> +<!-- Generated by javadoc (23) --> <title>CSVParser.Builder (Apache Commons CSV 1.13.1-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.csv, class: CSVParser, class: Builder"> -<meta name="generator" content="javadoc/ClassWriterImpl"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +<meta name="generator" content="javadoc/ClassWriter"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script-files/script.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> -<script type="text/javascript">var evenRowColor = "even-row-color"; -var oddRowColor = "odd-row-color"; -var tableTab = "table-tab"; -var activeTableTab = "active-table-tab"; -var pathtoroot = "../../../../"; +<script type="text/javascript">const pathtoroot = "../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> -<div class="flex-box"> -<header role="banner" class="flex-header"> +<header role="banner"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> +<div class="nav-content"> +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="package-summary.html">Package</a></li> @@ -37,43 +33,62 @@ loadScripts(document, 'script');</script <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="../../../../search.html">Search</a></li> <li><a href="../../../../help-doc.html#class">Help</a></li> </ul> </div> +</div> <div class="sub-nav"> -<div> -<ul class="sub-nav-list"> -<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="sub-nav-list"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor-detail">Constr</a> | </li> -<li><a href="#method-detail">Method</a></li> -</ul> +<div class="nav-content"> +<ol class="sub-nav-list"> +<li><a href="package-summary.html">org.apache.commons.csv</a></li> +<li><a href="CSVParser.html">CSVParser</a></li> +<li><a href="CSVParser.Builder.html" class="current-selection">Builder</a></li> +</ol> +<div class="nav-list-search"> +<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off"> +<input type="reset" id="reset-search" disabled value="Reset"> </div> -<div class="nav-list-search"><label for="search-input">SEARCH:</label> -<input type="text" id="search-input" value="search" disabled="disabled"> -<input type="reset" id="reset-button" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> -<div class="flex-content"> +<div class="main-grid"> +<nav role="navigation" class="toc" aria-label="Table of contents"> +<div class="toc-header">Contents +<input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off"> +<input type="reset" class="reset-filter" disabled value="Reset"> +</div> +<button class="hide-sidebar"><span>Hide sidebar </span>❮</button><button class="show-sidebar">❯<span> Show sidebar</span></button> +<ol class="toc-list"> +<li><a href="#" tabindex="0">Description</a></li> +<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li> +<li><a href="#method-summary" tabindex="0">Method Summary</a></li> +<li><a href="#constructor-detail" tabindex="0">Constructor Details</a> +<ol class="toc-list"> +<li><a href="#%3Cinit%3E()" tabindex="0">Builder()</a></li> +</ol> +</li> +<li><a href="#method-detail" tabindex="0">Method Details</a> +<ol class="toc-list"> +<li><a href="#get()" tabindex="0">get()</a></li> +<li><a href="#setCharacterOffset(long)" tabindex="0">setCharacterOffset(long)</a></li> +<li><a href="#setFormat(org.apache.commons.csv.CSVFormat)" tabindex="0">setFormat(CSVFormat)</a></li> +<li><a href="#setRecordNumber(long)" tabindex="0">setRecordNumber(long)</a></li> +<li><a href="#setTrackBytes(boolean)" tabindex="0">setTrackBytes(boolean)</a></li> +</ol> +</li> +</ol> +</nav> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> -<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.csv</a></div> <h1 title="Class CSVParser.Builder" class="title">Class CSVParser.Builder</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> -<div class="inheritance">org.apache.commons.io.build.AbstractSupplier<T,<wbr>B> -<div class="inheritance">org.apache.commons.io.build.AbstractOriginSupplier<T,<wbr>B> +<div class="inheritance">org.apache.commons.io.build.AbstractSupplier<<a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a>,<wbr><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a>> +<div class="inheritance">org.apache.commons.io.build.AbstractOriginSupplier<<a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a>,<wbr><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a>> <div class="inheritance">org.apache.commons.io.build.AbstractStreamBuilder<<a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a>,<wbr><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a>> <div class="inheritance">org.apache.commons.csv.CSVParser.Builder</div> </div> @@ -81,13 +96,14 @@ loadScripts(document, 'script');</script </div> </div> <section class="class-description" id="class-description"> +<div class="horizontal-scroll"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code>org.apache.commons.io.function.IOSupplier<<a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a>></code></dd> </dl> <dl class="notes"> <dt>Enclosing class:</dt> -<dd><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></dd> +<dd><code><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-153">CSVParser.Builder</a></span> @@ -97,6 +113,7 @@ loadScripts(document, 'script');</script <dt>Since:</dt> <dd>1.13.0</dd> </dl> +</div> </section> <section class="summary"> <ul class="summary-list"> @@ -183,8 +200,10 @@ loadScripts(document, 'script');</script <li> <section class="detail" id="<init>()"> <h3>Builder</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-163">Builder</a></span>()</div> <div class="block">Constructs a new instance.</div> +</div> </section> </li> </ul> @@ -198,17 +217,20 @@ loadScripts(document, 'script');</script <li> <section class="detail" id="get()"> <h3>get</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-167">get</a></span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <dl class="notes"> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="setCharacterOffset(long)"> <h3>setCharacterOffset</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-179">setCharacterOffset</a></span><wbr><span class="parameters">(long characterOffset)</span></div> <div class="block">Sets the lexer offset when the parser does not start parsing at the beginning of the source.</div> <dl class="notes"> @@ -217,11 +239,13 @@ loadScripts(document, 'script');</script <dt>Returns:</dt> <dd>this instance.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="setFormat(org.apache.commons.csv.CSVFormat)"> <h3>setFormat</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-190">setFormat</a></span><wbr><span class="parameters">(<a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span></div> <div class="block">Sets the CSV format. A copy of the given format is kept.</div> <dl class="notes"> @@ -230,11 +254,13 @@ loadScripts(document, 'script');</script <dt>Returns:</dt> <dd>this instance.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="setRecordNumber(long)"> <h3>setRecordNumber</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-201">setRecordNumber</a></span><wbr><span class="parameters">(long recordNumber)</span></div> <div class="block">Sets the next record number to assign, defaults to <code>1</code>.</div> <dl class="notes"> @@ -243,11 +269,13 @@ loadScripts(document, 'script');</script <dt>Returns:</dt> <dd>this instance.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="setTrackBytes(boolean)"> <h3>setTrackBytes</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.Builder.html#line-213">setTrackBytes</a></span><wbr><span class="parameters">(boolean trackBytes)</span></div> <div class="block">Sets whether to enable byte tracking for the parser.</div> <dl class="notes"> @@ -258,6 +286,7 @@ loadScripts(document, 'script');</script <dt>Since:</dt> <dd>1.13.0</dd> </dl> +</div> </section> </li> </ul> @@ -266,12 +295,11 @@ loadScripts(document, 'script');</script </ul> </section> <!-- ========= END OF CLASS DATA ========= --> -</main> <footer role="contentinfo"> <hr> <p class="legal-copy"><small>Copyright © 2005-2025 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</br><a href="https://commons.apache.org/proper/commons-csv/";>Apache Commons CSV</a> |<a href="https://issues.apache.org/jira/browse/CSV";>Issue management</a> |<a href="https://gitbox.apache.org/repos/asf?p=commons-csv.git";>Source repository</a></small></p> </footer> -</div> +</main> </div> </body> </html> \ No newline at end of file
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html (original) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html Mon Jan 13 14:52:07 2025 @@ -1,34 +1,30 @@ <!DOCTYPE HTML> <html lang> <head> -<!-- Generated by javadoc (17) --> +<!-- Generated by javadoc (23) --> <title>CSVParser (Apache Commons CSV 1.13.1-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.csv, class: CSVParser"> -<meta name="generator" content="javadoc/ClassWriterImpl"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +<meta name="generator" content="javadoc/ClassWriter"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script-files/script.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> -<script type="text/javascript">var evenRowColor = "even-row-color"; -var oddRowColor = "odd-row-color"; -var tableTab = "table-tab"; -var activeTableTab = "active-table-tab"; -var pathtoroot = "../../../../"; +<script type="text/javascript">const pathtoroot = "../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> -<div class="flex-box"> -<header role="banner" class="flex-header"> +<header role="banner"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> +<div class="nav-content"> +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="package-summary.html">Package</a></li> @@ -37,44 +33,88 @@ loadScripts(document, 'script');</script <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="../../../../search.html">Search</a></li> <li><a href="../../../../help-doc.html#class">Help</a></li> </ul> </div> +</div> <div class="sub-nav"> -<div> -<ul class="sub-nav-list"> -<li>Summary: </li> -<li><a href="#nested-class-summary">Nested</a> | </li> -<li>Field | </li> -<li><a href="#constructor-summary">Constr</a> | </li> -<li><a href="#method-summary">Method</a></li> -</ul> -<ul class="sub-nav-list"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor-detail">Constr</a> | </li> -<li><a href="#method-detail">Method</a></li> -</ul> +<div class="nav-content"> +<ol class="sub-nav-list"> +<li><a href="package-summary.html">org.apache.commons.csv</a></li> +<li><a href="CSVParser.html" class="current-selection">CSVParser</a></li> +</ol> +<div class="nav-list-search"> +<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off"> +<input type="reset" id="reset-search" disabled value="Reset"> </div> -<div class="nav-list-search"><label for="search-input">SEARCH:</label> -<input type="text" id="search-input" value="search" disabled="disabled"> -<input type="reset" id="reset-button" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> -<div class="flex-content"> +<div class="main-grid"> +<nav role="navigation" class="toc" aria-label="Table of contents"> +<div class="toc-header">Contents +<input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off"> +<input type="reset" class="reset-filter" disabled value="Reset"> +</div> +<button class="hide-sidebar"><span>Hide sidebar </span>❮</button><button class="show-sidebar">❯<span> Show sidebar</span></button> +<ol class="toc-list"> +<li><a href="#" tabindex="0">Description</a> +<ol class="toc-list"> +<li><a href="#creating-instances-heading" tabindex="0">Creating instances</a></li> +<li><a href="#parsing-record-wise-heading" tabindex="0">Parsing record wise</a></li> +<li><a href="#parsing-into-memory-heading" tabindex="0">Parsing into memory</a></li> +<li><a href="#notes-heading" tabindex="0">Notes</a></li> +</ol> +</li> +<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li> +<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li> +<li><a href="#method-summary" tabindex="0">Method Summary</a></li> +<li><a href="#constructor-detail" tabindex="0">Constructor Details</a> +<ol class="toc-list"> +<li><a href="#%3Cinit%3E(java.io.Reader,org.apache.commons.csv.CSVFormat)" tabindex="0">CSVParser(Reader, CSVFormat)</a></li> +<li><a href="#%3Cinit%3E(java.io.Reader,org.apache.commons.csv.CSVFormat,long,long)" tabindex="0">CSVParser(Reader, CSVFormat, long, long)</a></li> +</ol> +</li> +<li><a href="#method-detail" tabindex="0">Method Details</a> +<ol class="toc-list"> +<li><a href="#builder()" tabindex="0">builder()</a></li> +<li><a href="#parse(java.io.File,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(File, Charset, CSVFormat)</a></li> +<li><a href="#parse(java.io.InputStream,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(InputStream, Charset, CSVFormat)</a></li> +<li><a href="#parse(java.nio.file.Path,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(Path, Charset, CSVFormat)</a></li> +<li><a href="#parse(java.io.Reader,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(Reader, CSVFormat)</a></li> +<li><a href="#parse(java.lang.String,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(String, CSVFormat)</a></li> +<li><a href="#parse(java.net.URL,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)" tabindex="0">parse(URL, Charset, CSVFormat)</a></li> +<li><a href="#close()" tabindex="0">close()</a></li> +<li><a href="#getCurrentLineNumber()" tabindex="0">getCurrentLineNumber()</a></li> +<li><a href="#getFirstEndOfLine()" tabindex="0">getFirstEndOfLine()</a></li> +<li><a href="#getHeaderComment()" tabindex="0">getHeaderComment()</a></li> +<li><a href="#getHeaderMap()" tabindex="0">getHeaderMap()</a></li> +<li><a href="#getHeaderNames()" tabindex="0">getHeaderNames()</a></li> +<li><a href="#getRecordNumber()" tabindex="0">getRecordNumber()</a></li> +<li><a href="#getRecords()" tabindex="0">getRecords()</a></li> +<li><a href="#getTrailerComment()" tabindex="0">getTrailerComment()</a></li> +<li><a href="#hasHeaderComment()" tabindex="0">hasHeaderComment()</a></li> +<li><a href="#hasTrailerComment()" tabindex="0">hasTrailerComment()</a></li> +<li><a href="#isClosed()" tabindex="0">isClosed()</a></li> +<li><a href="#iterator()" tabindex="0">iterator()</a></li> +<li><a href="#stream()" tabindex="0">stream()</a></li> +</ol> +</li> +</ol> +</nav> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> -<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.csv</a></div> <h1 title="Class CSVParser" class="title">Class CSVParser</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">org.apache.commons.csv.CSVParser</div> </div> <section class="class-description" id="class-description"> +<div class="horizontal-scroll"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html"; title="class or interface in java.lang" class="external-link">Iterable</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></dd> @@ -90,7 +130,7 @@ implements <a href="https://docs.oracle. 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> + <h2 id="creating-instances-heading">Creating instances</h2> <p> There are several static factory methods that can be used to create instances for various types of resources: </p> @@ -110,7 +150,7 @@ implements <a href="https://docs.oracle. } </pre> - <h2>Parsing record wise</h2> + <h2 id="parsing-record-wise-heading">Parsing record wise</h2> <p> To parse a CSV input from a file, you write: </p> @@ -144,7 +184,7 @@ implements <a href="https://docs.oracle. customizing CSVFormats is available in <a href="CSVFormat.html" title="class in org.apache.commons.csv"><code>CSVFormat Javadoc</code></a>. </p> - <h2>Parsing into memory</h2> + <h2 id="parsing-into-memory-heading">Parsing into memory</h2> <p> If parsing record-wise is not desired, the contents of the input can be read completely into memory. </p> @@ -166,18 +206,19 @@ implements <a href="https://docs.oracle. parsing a 150MB file of CSV data the contents will be read completely into memory.</li> </ol> - <h2>Notes</h2> + <h2 id="notes-heading">Notes</h2> <p> The internal parser state is completely covered by the format and the reader state. </p></div> <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="package-summary.html">package documentation for more details</a></li> </ul> </dd> </dl> +</div> </section> <section class="summary"> <ul class="summary-list"> @@ -261,12 +302,12 @@ implements <a href="https://docs.oracle. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets the header comment, if any.</div> </div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html"; title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Integer.html"; title="class or interface in java.lang" class="external-link">Integer</a>></code></div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html"; title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Integer.html"; title="class or interface in java.lang" class="external-link">Integer</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaderMap()" class="member-name-link">getHeaderMap</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets a copy of the header map as defined in the CSVFormat's header.</div> </div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>></code></div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaderNames()" class="member-name-link">getHeaderNames</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets a read-only list of header names that iterates in column order as defined in the CSVFormat's header.</div> @@ -276,7 +317,7 @@ implements <a href="https://docs.oracle. <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets the current record number in the input stream.</div> </div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><wbr><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRecords()" class="member-name-link">getRecords</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Parses the CSV input according to the given format and returns the content as a list of @@ -302,7 +343,7 @@ implements <a href="https://docs.oracle. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Tests whether this parser is closed.</div> </div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html"; title="class or interface in java.util" class="external-link">Iterator</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html"; title="class or interface in java.util" class="external-link">Iterator</a><wbr><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Returns the record iterator.</div> @@ -347,7 +388,7 @@ implements <a href="https://docs.oracle. <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="block">Creates and returns a parser for the given <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html"; title="class or interface in java.nio.file" class="external-link"><code>Path</code></a>, which the caller MUST close.</div> </div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link">Stream</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link">Stream</a><wbr><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stream()" class="member-name-link">stream</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Returns a sequential <code>Stream</code> with this collection as its source.</div> @@ -375,6 +416,7 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="<init>(java.io.Reader,org.apache.commons.csv.CSVFormat)"> <h3>CSVParser</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html"; title="class or interface in java.lang" class="external-link">@Deprecated</a> </span><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-494">CSVParser</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Reader.html"; title="class or interface in java.io" class="external-link">Reader</a> reader, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> @@ -397,11 +439,13 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If there is a problem reading the header or skipping the first record</dd> <dd><code><a href="CSVException.html" title="class in org.apache.commons.csv">CSVException</a></code> - Thrown on invalid input.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="<init>(java.io.Reader,org.apache.commons.csv.CSVFormat,long,long)"> <h3>CSVParser</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html"; title="class or interface in java.lang" class="external-link">@Deprecated</a> </span><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-523">CSVParser</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Reader.html"; title="class or interface in java.io" class="external-link">Reader</a> reader, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format, @@ -430,6 +474,7 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.1</dd> </dl> +</div> </section> </li> </ul> @@ -443,6 +488,7 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="builder()"> <h3>builder</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.Builder.html" title="class in org.apache.commons.csv">CSVParser.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-297">builder</a></span>()</div> <div class="block">Creates a new builder.</div> <dl class="notes"> @@ -451,11 +497,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.13.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.io.File,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-317">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> file, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/charset/Charset.html"; title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> @@ -473,11 +521,13 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> <dd><code><a href="CSVException.html" title="class in org.apache.commons.csv">CSVException</a></code> - Thrown on invalid input.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.io.InputStream,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-344">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/InputStream.html"; title="class or interface in java.io" class="external-link">InputStream</a> inputStream, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/charset/Charset.html"; title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> @@ -502,11 +552,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.5</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.nio.file.Path,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-369">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html"; title="class or interface in java.nio.file" class="external-link">Path</a> path, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/charset/Charset.html"; title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> @@ -526,11 +578,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.5</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.io.Reader,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-396">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Reader.html"; title="class or interface in java.io" class="external-link">Reader</a> reader, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> @@ -553,11 +607,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.5</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.lang.String,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-414">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> string, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> @@ -573,11 +629,13 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> <dd><code><a href="CSVException.html" title="class in org.apache.commons.csv">CSVException</a></code> - Thrown on invalid input.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.net.URL,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"> <h3>parse</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-441">parse</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URL.html"; title="class or interface in java.net" class="external-link">URL</a> url, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/charset/Charset.html"; title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> @@ -600,11 +658,13 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> <dd><code><a href="CSVException.html" title="class in org.apache.commons.csv">CSVException</a></code> - Thrown on invalid input.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="close()"> <h3>close</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-582">close</a></span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Closes resources.</div> @@ -616,11 +676,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getCurrentLineNumber()"> <h3>getCurrentLineNumber</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-672">getCurrentLineNumber</a></span>()</div> <div class="block">Gets the current line number in the input stream. @@ -632,11 +694,13 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>current line number</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getFirstEndOfLine()"> <h3>getFirstEndOfLine</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-682">getFirstEndOfLine</a></span>()</div> <div class="block">Gets the first end-of-line string encountered.</div> <dl class="notes"> @@ -645,11 +709,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.5</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getHeaderComment()"> <h3>getHeaderComment</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-693">getHeaderComment</a></span>()</div> <div class="block">Gets the header comment, if any. The header comment appears before the header record.</div> @@ -659,11 +725,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getHeaderMap()"> <h3>getHeaderMap</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html"; title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Integer.html"; title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-709">getHeaderMap</a></span>()</div> <div class="block">Gets a copy of the header map as defined in the CSVFormat's header. <p> @@ -677,11 +745,13 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>a copy of the header map.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getHeaderNames()"> <h3>getHeaderNames</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-739">getHeaderNames</a></span>()</div> <div class="block">Gets a read-only list of header names that iterates in column order as defined in the CSVFormat's header. <p> @@ -696,16 +766,18 @@ implements <a href="https://docs.oracle. <dd>1.7</dd> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="#getHeaderMap()"><code>getHeaderMap()</code></a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getRecordNumber()"> <h3>getRecordNumber</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-753">getRecordNumber</a></span>()</div> <div class="block">Gets the current record number in the input stream. @@ -717,11 +789,13 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>current record number</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getRecords()"> <h3>getRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-769">getRecords</a></span>()</div> <div class="block">Parses the CSV input according to the given format and returns the content as a list of <a href="CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecords</code></a>. @@ -735,11 +809,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/UncheckedIOException.html"; title="class or interface in java.io" class="external-link">UncheckedIOException</a></code> - on parse error or input read-failure</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getTrailerComment()"> <h3>getTrailerComment</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-780">getTrailerComment</a></span>()</div> <div class="block">Gets the trailer comment, if any. Trailer comments are located between the last record and EOF</div> @@ -749,11 +825,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="hasHeaderComment()"> <h3>hasHeaderComment</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-815">hasHeaderComment</a></span>()</div> <div class="block">Checks whether there is a header comment. The header comment appears before the header record. @@ -768,11 +846,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="hasTrailerComment()"> <h3>hasTrailerComment</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-828">hasTrailerComment</a></span>()</div> <div class="block">Checks whether there is a trailer comment. Trailer comments are located between the last record and EOF. @@ -784,22 +864,26 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="isClosed()"> <h3>isClosed</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-837">isClosed</a></span>()</div> <div class="block">Tests whether this parser is closed.</div> <dl class="notes"> <dt>Returns:</dt> <dd>whether this parser is closed.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="iterator()"> <h3>iterator</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html"; title="class or interface in java.util" class="external-link">Iterator</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-871">iterator</a></span>()</div> <div class="block">Returns the record iterator. @@ -822,11 +906,13 @@ implements <a href="https://docs.oracle. <dt>Specified by:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html"; title="class or interface in java.lang" class="external-link">Iterable</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="stream()"> <h3>stream</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link">Stream</a><<a href="CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVParser.html#line-940">stream</a></span>()</div> <div class="block">Returns a sequential <code>Stream</code> with this collection as its source. <p> @@ -839,6 +925,7 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.9.0</dd> </dl> +</div> </section> </li> </ul> @@ -847,12 +934,11 @@ implements <a href="https://docs.oracle. </ul> </section> <!-- ========= END OF CLASS DATA ========= --> -</main> <footer role="contentinfo"> <hr> <p class="legal-copy"><small>Copyright © 2005-2025 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</br><a href="https://commons.apache.org/proper/commons-csv/";>Apache Commons CSV</a> |<a href="https://issues.apache.org/jira/browse/CSV";>Issue management</a> |<a href="https://gitbox.apache.org/repos/asf?p=commons-csv.git";>Source repository</a></small></p> </footer> -</div> +</main> </div> </body> </html> \ No newline at end of file Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html (original) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html Mon Jan 13 14:52:07 2025 @@ -1,34 +1,30 @@ <!DOCTYPE HTML> <html lang> <head> -<!-- Generated by javadoc (17) --> +<!-- Generated by javadoc (23) --> <title>CSVPrinter (Apache Commons CSV 1.13.1-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.csv, class: CSVPrinter"> -<meta name="generator" content="javadoc/ClassWriterImpl"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> +<meta name="generator" content="javadoc/ClassWriter"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script-files/script.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> -<script type="text/javascript">var evenRowColor = "even-row-color"; -var oddRowColor = "odd-row-color"; -var tableTab = "table-tab"; -var activeTableTab = "active-table-tab"; -var pathtoroot = "../../../../"; +<script type="text/javascript">const pathtoroot = "../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> -<div class="flex-box"> -<header role="banner" class="flex-header"> +<header role="banner"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> +<div class="nav-content"> +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="package-summary.html">Package</a></li> @@ -37,44 +33,75 @@ loadScripts(document, 'script');</script <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="../../../../search.html">Search</a></li> <li><a href="../../../../help-doc.html#class">Help</a></li> </ul> </div> +</div> <div class="sub-nav"> -<div> -<ul class="sub-nav-list"> -<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="sub-nav-list"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor-detail">Constr</a> | </li> -<li><a href="#method-detail">Method</a></li> -</ul> +<div class="nav-content"> +<ol class="sub-nav-list"> +<li><a href="package-summary.html">org.apache.commons.csv</a></li> +<li><a href="CSVPrinter.html" class="current-selection">CSVPrinter</a></li> +</ol> +<div class="nav-list-search"> +<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off"> +<input type="reset" id="reset-search" disabled value="Reset"> </div> -<div class="nav-list-search"><label for="search-input">SEARCH:</label> -<input type="text" id="search-input" value="search" disabled="disabled"> -<input type="reset" id="reset-button" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> -<div class="flex-content"> +<div class="main-grid"> +<nav role="navigation" class="toc" aria-label="Table of contents"> +<div class="toc-header">Contents +<input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off"> +<input type="reset" class="reset-filter" disabled value="Reset"> +</div> +<button class="hide-sidebar"><span>Hide sidebar </span>❮</button><button class="show-sidebar">❯<span> Show sidebar</span></button> +<ol class="toc-list"> +<li><a href="#" tabindex="0">Description</a></li> +<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li> +<li><a href="#method-summary" tabindex="0">Method Summary</a></li> +<li><a href="#constructor-detail" tabindex="0">Constructor Details</a> +<ol class="toc-list"> +<li><a href="#%3Cinit%3E(java.lang.Appendable,org.apache.commons.csv.CSVFormat)" tabindex="0">CSVPrinter(Appendable, CSVFormat)</a></li> +</ol> +</li> +<li><a href="#method-detail" tabindex="0">Method Details</a> +<ol class="toc-list"> +<li><a href="#close()" tabindex="0">close()</a></li> +<li><a href="#close(boolean)" tabindex="0">close(boolean)</a></li> +<li><a href="#flush()" tabindex="0">flush()</a></li> +<li><a href="#getOut()" tabindex="0">getOut()</a></li> +<li><a href="#getRecordCount()" tabindex="0">getRecordCount()</a></li> +<li><a href="#print(java.lang.Object)" tabindex="0">print(Object)</a></li> +<li><a href="#printComment(java.lang.String)" tabindex="0">printComment(String)</a></li> +<li><a href="#printHeaders(java.sql.ResultSet)" tabindex="0">printHeaders(ResultSet)</a></li> +<li><a href="#println()" tabindex="0">println()</a></li> +<li><a href="#printRecord(java.lang.Iterable)" tabindex="0">printRecord(Iterable)</a></li> +<li><a href="#printRecord(java.lang.Object...)" tabindex="0">printRecord(Object...)</a></li> +<li><a href="#printRecord(java.util.stream.Stream)" tabindex="0">printRecord(Stream)</a></li> +<li><a href="#printRecords(java.lang.Iterable)" tabindex="0">printRecords(Iterable)</a></li> +<li><a href="#printRecords(java.lang.Object...)" tabindex="0">printRecords(Object...)</a></li> +<li><a href="#printRecords(java.sql.ResultSet)" tabindex="0">printRecords(ResultSet)</a></li> +<li><a href="#printRecords(java.sql.ResultSet,boolean)" tabindex="0">printRecords(ResultSet, boolean)</a></li> +<li><a href="#printRecords(java.util.stream.Stream)" tabindex="0">printRecords(Stream)</a></li> +</ol> +</li> +</ol> +</nav> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> -<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.csv</a></div> <h1 title="Class CSVPrinter" class="title">Class CSVPrinter</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">org.apache.commons.csv.CSVPrinter</div> </div> <section class="class-description" id="class-description"> +<div class="horizontal-scroll"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Flushable.html"; title="class or interface in java.io" class="external-link">Flushable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> @@ -118,6 +145,7 @@ implements <a href="https://docs.oracle. 2,mary,Mary,Meyer,1985-03-29 </pre></div> +</div> </section> <section class="summary"> <ul class="summary-list"> @@ -252,6 +280,7 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="<init>(java.lang.Appendable,org.apache.commons.csv.CSVFormat)"> <h3>CSVPrinter</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-106">CSVPrinter</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Appendable.html"; title="class or interface in java.lang" class="external-link">Appendable</a> appendable, <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> format)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> @@ -268,6 +297,7 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - thrown if the optional header cannot be printed.</dd> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html"; title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - thrown if the parameters of the format are inconsistent or if either out or format are null.</dd> </dl> +</div> </section> </li> </ul> @@ -281,6 +311,7 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="close()"> <h3>close</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-125">close</a></span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <dl class="notes"> @@ -291,11 +322,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="close(boolean)"> <h3>close</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-137">close</a></span><wbr><span class="parameters">(boolean flush)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Closes the underlying stream with an optional flush first.</div> @@ -307,11 +340,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.6</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="flush()"> <h3>flush</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-163">flush</a></span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Flushes the underlying stream.</div> @@ -321,22 +356,26 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getOut()"> <h3>getOut</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Appendable.html"; title="class or interface in java.lang" class="external-link">Appendable</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-175">getOut</a></span>()</div> <div class="block">Gets the target Appendable.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the target Appendable.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getRecordCount()"> <h3>getRecordCount</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-185">getRecordCount</a></span>()</div> <div class="block">Gets the record count printed, this does not include comments or headers.</div> <dl class="notes"> @@ -345,11 +384,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.13.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="print(java.lang.Object)"> <h3>print</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-197">print</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a> value)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints the string as the next value on the line. The value will be escaped or encapsulated as needed.</div> @@ -359,11 +400,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printComment(java.lang.String)"> <h3>printComment</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-223">printComment</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> comment)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints a comment on a new line among the delimiter-separated values. @@ -386,11 +429,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printHeaders(java.sql.ResultSet)"> <h3>printHeaders</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-261">printHeaders</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/ResultSet.html"; title="class or interface in java.sql" class="external-link">ResultSet</a> resultSet)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/SQLException.html"; title="class or interface in java.sql" class="external-link">SQLException</a></span></div> @@ -404,11 +449,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.9.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="println()"> <h3>println</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-274">println</a></span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Outputs the record separator.</div> @@ -416,11 +463,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecord(java.lang.Iterable)"> <h3>printRecord</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-292">printRecord</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html"; title="class or interface in java.lang" class="external-link">Iterable</a><?> values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints the given values as a single record of delimiter-separated values followed by the record separator. @@ -435,11 +484,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecord(java.lang.Object...)"> <h3>printRecord</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-311">printRecord</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a>... values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints the given values as a single record of delimiter-separated values followed by the record separator. @@ -454,11 +505,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecord(java.util.stream.Stream)"> <h3>printRecord</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-329">printRecord</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link">Stream</a><?> values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints the given values as a single record of delimiter-separated values followed by the record separator. @@ -475,11 +528,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecords(java.lang.Iterable)"> <h3>printRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-383">printRecords</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html"; title="class or interface in java.lang" class="external-link">Iterable</a><?> values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints all the objects in the given <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html"; title="class or interface in java.lang" class="external-link"><code>Iterable</code></a> handling nested collections/arrays as records. @@ -519,11 +574,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecords(java.lang.Object...)"> <h3>printRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-425">printRecords</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a>... values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints all the objects in the given array handling nested collections/arrays as records. @@ -562,11 +619,13 @@ implements <a href="https://docs.oracle. <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecords(java.sql.ResultSet)"> <h3>printRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-439">printRecords</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/ResultSet.html"; title="class or interface in java.sql" class="external-link">ResultSet</a> resultSet)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/SQLException.html"; title="class or interface in java.sql" class="external-link">SQLException</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> @@ -578,11 +637,13 @@ implements <a href="https://docs.oracle. <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs.</dd> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/SQLException.html"; title="class or interface in java.sql" class="external-link">SQLException</a></code> - Thrown when a database access error occurs.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecords(java.sql.ResultSet,boolean)"> <h3>printRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-469">printRecords</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/ResultSet.html"; title="class or interface in java.sql" class="external-link">ResultSet</a> resultSet, boolean printHeader)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/SQLException.html"; title="class or interface in java.sql" class="external-link">SQLException</a>, @@ -598,11 +659,13 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.9.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="printRecords(java.util.stream.Stream)"> <h3>printRecords</h3> +<div class="horizontal-scroll"> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line-516">printRecords</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link">Stream</a><?> values)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block">Prints all the objects in the given <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/stream/Stream.html"; title="class or interface in java.util.stream" class="external-link"><code>Stream</code></a> handling nested collections/arrays as records. @@ -645,6 +708,7 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> </ul> @@ -653,12 +717,11 @@ implements <a href="https://docs.oracle. </ul> </section> <!-- ========= END OF CLASS DATA ========= --> -</main> <footer role="contentinfo"> <hr> <p class="legal-copy"><small>Copyright © 2005-2025 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</br><a href="https://commons.apache.org/proper/commons-csv/";>Apache Commons CSV</a> |<a href="https://issues.apache.org/jira/browse/CSV";>Issue management</a> |<a href="https://gitbox.apache.org/repos/asf?p=commons-csv.git";>Source repository</a></small></p> </footer> -</div> +</main> </div> </body> </html> \ No newline at end of file
