Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html (original) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.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>CSVFormat (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: CSVFormat"> -<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,156 @@ 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><a href="#field-summary">Field</a> | </li> -<li>Constr | </li> -<li><a href="#method-summary">Method</a></li> -</ul> -<ul class="sub-nav-list"> -<li>Detail: </li> -<li><a href="#field-detail">Field</a> | </li> -<li>Constr | </li> -<li><a href="#method-detail">Method</a></li> -</ul> -</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 class="nav-content"> +<ol class="sub-nav-list"> +<li><a href="package-summary.html">org.apache.commons.csv</a></li> +<li><a href="CSVFormat.html" class="current-selection">CSVFormat</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> </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="#using-predefined-formats-heading" tabindex="0">Using predefined formats</a></li> +<li><a href="#defining-formats-heading" tabindex="0">Defining formats</a></li> +<li><a href="#defining-column-names-heading" tabindex="0">Defining column names</a></li> +<li><a href="#parsing-heading" tabindex="0">Parsing</a></li> +<li><a href="#referencing-columns-safely-heading" tabindex="0">Referencing columns safely</a></li> +<li><a href="#serialization-heading" tabindex="0">Serialization</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="#field-summary" tabindex="0">Field Summary</a></li> +<li><a href="#method-summary" tabindex="0">Method Summary</a></li> +<li><a href="#field-detail" tabindex="0">Field Details</a> +<ol class="toc-list"> +<li><a href="#DEFAULT" tabindex="0">DEFAULT</a></li> +<li><a href="#EXCEL" tabindex="0">EXCEL</a></li> +<li><a href="#INFORMIX_UNLOAD" tabindex="0">INFORMIX_UNLOAD</a></li> +<li><a href="#INFORMIX_UNLOAD_CSV" tabindex="0">INFORMIX_UNLOAD_CSV</a></li> +<li><a href="#MONGODB_CSV" tabindex="0">MONGODB_CSV</a></li> +<li><a href="#MONGODB_TSV" tabindex="0">MONGODB_TSV</a></li> +<li><a href="#MYSQL" tabindex="0">MYSQL</a></li> +<li><a href="#ORACLE" tabindex="0">ORACLE</a></li> +<li><a href="#POSTGRESQL_CSV" tabindex="0">POSTGRESQL_CSV</a></li> +<li><a href="#POSTGRESQL_TEXT" tabindex="0">POSTGRESQL_TEXT</a></li> +<li><a href="#RFC4180" tabindex="0">RFC4180</a></li> +<li><a href="#TDF" tabindex="0">TDF</a></li> +</ol> +</li> +<li><a href="#method-detail" tabindex="0">Method Details</a> +<ol class="toc-list"> +<li><a href="#newFormat(char)" tabindex="0">newFormat(char)</a></li> +<li><a href="#valueOf(java.lang.String)" tabindex="0">valueOf(String)</a></li> +<li><a href="#builder()" tabindex="0">builder()</a></li> +<li><a href="#equals(java.lang.Object)" tabindex="0">equals(Object)</a></li> +<li><a href="#format(java.lang.Object...)" tabindex="0">format(Object...)</a></li> +<li><a href="#getAllowDuplicateHeaderNames()" tabindex="0">getAllowDuplicateHeaderNames()</a></li> +<li><a href="#getAllowMissingColumnNames()" tabindex="0">getAllowMissingColumnNames()</a></li> +<li><a href="#getAutoFlush()" tabindex="0">getAutoFlush()</a></li> +<li><a href="#getCommentMarker()" tabindex="0">getCommentMarker()</a></li> +<li><a href="#getDelimiter()" tabindex="0">getDelimiter()</a></li> +<li><a href="#getDelimiterString()" tabindex="0">getDelimiterString()</a></li> +<li><a href="#getDuplicateHeaderMode()" tabindex="0">getDuplicateHeaderMode()</a></li> +<li><a href="#getEscapeCharacter()" tabindex="0">getEscapeCharacter()</a></li> +<li><a href="#getHeader()" tabindex="0">getHeader()</a></li> +<li><a href="#getHeaderComments()" tabindex="0">getHeaderComments()</a></li> +<li><a href="#getIgnoreEmptyLines()" tabindex="0">getIgnoreEmptyLines()</a></li> +<li><a href="#getIgnoreHeaderCase()" tabindex="0">getIgnoreHeaderCase()</a></li> +<li><a href="#getIgnoreSurroundingSpaces()" tabindex="0">getIgnoreSurroundingSpaces()</a></li> +<li><a href="#getLenientEof()" tabindex="0">getLenientEof()</a></li> +<li><a href="#getNullString()" tabindex="0">getNullString()</a></li> +<li><a href="#getQuoteCharacter()" tabindex="0">getQuoteCharacter()</a></li> +<li><a href="#getQuoteMode()" tabindex="0">getQuoteMode()</a></li> +<li><a href="#getRecordSeparator()" tabindex="0">getRecordSeparator()</a></li> +<li><a href="#getSkipHeaderRecord()" tabindex="0">getSkipHeaderRecord()</a></li> +<li><a href="#getTrailingData()" tabindex="0">getTrailingData()</a></li> +<li><a href="#getTrailingDelimiter()" tabindex="0">getTrailingDelimiter()</a></li> +<li><a href="#getTrim()" tabindex="0">getTrim()</a></li> +<li><a href="#hashCode()" tabindex="0">hashCode()</a></li> +<li><a href="#isCommentMarkerSet()" tabindex="0">isCommentMarkerSet()</a></li> +<li><a href="#isEscapeCharacterSet()" tabindex="0">isEscapeCharacterSet()</a></li> +<li><a href="#isNullStringSet()" tabindex="0">isNullStringSet()</a></li> +<li><a href="#isQuoteCharacterSet()" tabindex="0">isQuoteCharacterSet()</a></li> +<li><a href="#parse(java.io.Reader)" tabindex="0">parse(Reader)</a></li> +<li><a href="#print(java.lang.Appendable)" tabindex="0">print(Appendable)</a></li> +<li><a href="#print(java.io.File,java.nio.charset.Charset)" tabindex="0">print(File, Charset)</a></li> +<li><a href="#print(java.lang.Object,java.lang.Appendable,boolean)" tabindex="0">print(Object, Appendable, boolean)</a></li> +<li><a href="#print(java.nio.file.Path,java.nio.charset.Charset)" tabindex="0">print(Path, Charset)</a></li> +<li><a href="#printer()" tabindex="0">printer()</a></li> +<li><a href="#println(java.lang.Appendable)" tabindex="0">println(Appendable)</a></li> +<li><a href="#printRecord(java.lang.Appendable,java.lang.Object...)" tabindex="0">printRecord(Appendable, Object...)</a></li> +<li><a href="#toString()" tabindex="0">toString()</a></li> +<li><a href="#withAllowDuplicateHeaderNames()" tabindex="0">withAllowDuplicateHeaderNames()</a></li> +<li><a href="#withAllowDuplicateHeaderNames(boolean)" tabindex="0">withAllowDuplicateHeaderNames(boolean)</a></li> +<li><a href="#withAllowMissingColumnNames()" tabindex="0">withAllowMissingColumnNames()</a></li> +<li><a href="#withAllowMissingColumnNames(boolean)" tabindex="0">withAllowMissingColumnNames(boolean)</a></li> +<li><a href="#withAutoFlush(boolean)" tabindex="0">withAutoFlush(boolean)</a></li> +<li><a href="#withCommentMarker(char)" tabindex="0">withCommentMarker(char)</a></li> +<li><a href="#withCommentMarker(java.lang.Character)" tabindex="0">withCommentMarker(Character)</a></li> +<li><a href="#withDelimiter(char)" tabindex="0">withDelimiter(char)</a></li> +<li><a href="#withEscape(char)" tabindex="0">withEscape(char)</a></li> +<li><a href="#withEscape(java.lang.Character)" tabindex="0">withEscape(Character)</a></li> +<li><a href="#withFirstRecordAsHeader()" tabindex="0">withFirstRecordAsHeader()</a></li> +<li><a href="#withHeader(java.lang.Class)" tabindex="0">withHeader(Class)</a></li> +<li><a href="#withHeader(java.sql.ResultSet)" tabindex="0">withHeader(ResultSet)</a></li> +<li><a href="#withHeader(java.sql.ResultSetMetaData)" tabindex="0">withHeader(ResultSetMetaData)</a></li> +<li><a href="#withHeader(java.lang.String...)" tabindex="0">withHeader(String...)</a></li> +<li><a href="#withHeaderComments(java.lang.Object...)" tabindex="0">withHeaderComments(Object...)</a></li> +<li><a href="#withIgnoreEmptyLines()" tabindex="0">withIgnoreEmptyLines()</a></li> +<li><a href="#withIgnoreEmptyLines(boolean)" tabindex="0">withIgnoreEmptyLines(boolean)</a></li> +<li><a href="#withIgnoreHeaderCase()" tabindex="0">withIgnoreHeaderCase()</a></li> +<li><a href="#withIgnoreHeaderCase(boolean)" tabindex="0">withIgnoreHeaderCase(boolean)</a></li> +<li><a href="#withIgnoreSurroundingSpaces()" tabindex="0">withIgnoreSurroundingSpaces()</a></li> +<li><a href="#withIgnoreSurroundingSpaces(boolean)" tabindex="0">withIgnoreSurroundingSpaces(boolean)</a></li> +<li><a href="#withNullString(java.lang.String)" tabindex="0">withNullString(String)</a></li> +<li><a href="#withQuote(char)" tabindex="0">withQuote(char)</a></li> +<li><a href="#withQuote(java.lang.Character)" tabindex="0">withQuote(Character)</a></li> +<li><a href="#withQuoteMode(org.apache.commons.csv.QuoteMode)" tabindex="0">withQuoteMode(QuoteMode)</a></li> +<li><a href="#withRecordSeparator(char)" tabindex="0">withRecordSeparator(char)</a></li> +<li><a href="#withRecordSeparator(java.lang.String)" tabindex="0">withRecordSeparator(String)</a></li> +<li><a href="#withSkipHeaderRecord()" tabindex="0">withSkipHeaderRecord()</a></li> +<li><a href="#withSkipHeaderRecord(boolean)" tabindex="0">withSkipHeaderRecord(boolean)</a></li> +<li><a href="#withSystemRecordSeparator()" tabindex="0">withSystemRecordSeparator()</a></li> +<li><a href="#withTrailingDelimiter()" tabindex="0">withTrailingDelimiter()</a></li> +<li><a href="#withTrailingDelimiter(boolean)" tabindex="0">withTrailingDelimiter(boolean)</a></li> +<li><a href="#withTrim()" tabindex="0">withTrim()</a></li> +<li><a href="#withTrim(boolean)" tabindex="0">withTrim(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 CSVFormat" class="title">Class CSVFormat</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.CSVFormat</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/Serializable.html"; title="class or interface in java.io" class="external-link">Serializable</a></code></dd> @@ -85,7 +193,7 @@ loadScripts(document, 'script');</script implements <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html"; title="class or interface in java.io" class="external-link">Serializable</a></span></div> <div class="block">Specifies the format of a CSV file for parsing and writing. - <h2>Using predefined formats</h2> + <h2 id="using-predefined-formats-heading">Using predefined formats</h2> <p> You can use one of the predefined formats: @@ -122,7 +230,7 @@ implements <a href="https://docs.oracle. CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL); </pre> - <h2>Defining formats</h2> + <h2 id="defining-formats-heading">Defining formats</h2> <p> You can extend a format by calling the <code>set</code> methods. For example: @@ -132,7 +240,7 @@ implements <a href="https://docs.oracle. CSVFormat.EXCEL.builder().setNullString("N/A").setIgnoreSurroundingSpaces(true).get(); </code></pre> - <h2>Defining column names</h2> + <h2 id="defining-column-names-heading">Defining column names</h2> <p> To define the column names you want to use to access records, write: @@ -150,7 +258,7 @@ implements <a href="https://docs.oracle. <a href="CSVFormat.Builder.html#setSkipHeaderRecord(boolean)"><code>CSVFormat.Builder.setSkipHeaderRecord(boolean)</code></a> with <code>true</code>. </p> - <h2>Parsing</h2> + <h2 id="parsing-heading">Parsing</h2> <p> You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write: @@ -165,7 +273,7 @@ implements <a href="https://docs.oracle. For other input types, like resources, files, and URLs, use the static methods on <a href="CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a>. </p> - <h2>Referencing columns safely</h2> + <h2 id="referencing-columns-safely-heading">Referencing columns safely</h2> <p> If your source contains a header record, you can simplify your code and safely reference columns, by using <a href="CSVFormat.Builder.html#setHeader(java.lang.String...)"><code>CSVFormat.Builder.setHeader(String...)</code></a> with no @@ -190,7 +298,7 @@ implements <a href="https://docs.oracle. This makes your code impervious to changes in column order in the CSV file. </p> - <h2>Serialization</h2> + <h2 id="serialization-heading">Serialization</h2> <p> This class implements the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html"; title="class or interface in java.io" class="external-link"><code>Serializable</code></a> interface with the following caveats: </p> @@ -206,7 +314,7 @@ implements <a href="https://docs.oracle. <li>Version 1.9.0 through 1.0: <code>1L</code></li> </ul> - <h2>Notes</h2> + <h2 id="notes-heading">Notes</h2> <p> This class is immutable. </p> @@ -216,11 +324,12 @@ implements <a href="https://docs.oracle. <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized Form</a></li> </ul> </dd> </dl> +</div> </section> <section class="summary"> <ul class="summary-list"> @@ -313,7 +422,7 @@ implements <a href="https://docs.oracle. <div class="col-first odd-row-color"><code>static final <a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></div> <div class="col-second odd-row-color"><code><a href="#TDF" class="member-name-link">TDF</a></code></div> <div class="col-last odd-row-color"> -<div class="block">Tab-delimited format.</div> +<div class="block">Tab-delimited format (TDF).</div> </div> </div> </section> @@ -802,33 +911,37 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="DEFAULT"> <h3>DEFAULT</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-985">DEFAULT</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1001">DEFAULT</a></span></div> <div class="block">Standard Comma Separated Value format, as for <a href="#RFC4180"><code>RFC4180</code></a> but allowing empty lines. <p> The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setRecordSeparator("\r\n")</code></li> - <li><code>setIgnoreEmptyLines(true)</code></li> - <li><code>setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(java.lang.String)"><code>setRecordSeparator</code></a><code>("\r\n")</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(true)</code></li> + <li><a href="CSVFormat.Builder.html#setDuplicateHeaderMode(org.apache.commons.csv.DuplicateHeaderMode)"><code>setDuplicateHeaderMode</code></a><code>(DuplicateHeaderMode.ALLOW_ALL)</code></li> </ul></div> <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="CSVFormat.Predefined.html#Default"><code>CSVFormat.Predefined.Default</code></a></li> +<li><a href="DuplicateHeaderMode.html#ALLOW_ALL"><code>DuplicateHeaderMode.ALLOW_ALL</code></a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="EXCEL"> <h3>EXCEL</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1020">EXCEL</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1037">EXCEL</a></span></div> <div class="block">Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is locale-dependent, it might be necessary to customize this format to accommodate your regional settings. @@ -841,17 +954,17 @@ implements <a href="https://docs.oracle. </pre> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setRecordSeparator("\r\n")</code></li> - <li><code>setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> - <li><code>setAllowMissingColumnNames(true)</code></li> - <li><code>setTrailingData(true)</code></li> - <li><code>setLenientEof(true)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(java.lang.String)"><code>setRecordSeparator</code></a><code>("\r\n")</code></li> + <li><a href="CSVFormat.Builder.html#setDuplicateHeaderMode(org.apache.commons.csv.DuplicateHeaderMode)"><code>setDuplicateHeaderMode</code></a><code>(DuplicateHeaderMode.ALLOW_ALL)</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> + <li><a href="CSVFormat.Builder.html#setAllowMissingColumnNames(boolean)"><code>setAllowMissingColumnNames</code></a><code>(true)</code></li> + <li><a href="CSVFormat.Builder.html#setTrailingData(boolean)"><code>setTrailingData</code></a><code>(true)</code></li> + <li><a href="CSVFormat.Builder.html#setLenientEof(boolean)"><code>setLenientEof</code></a><code>(true)</code></li> </ul> <p> Note: This is currently like <a href="#RFC4180"><code>RFC4180</code></a> plus <a href="CSVFormat.Builder.html#setAllowMissingColumnNames(boolean)"><code>Builder#setAllowMissingColumnNames(true)</code></a> and @@ -860,17 +973,20 @@ implements <a href="https://docs.oracle. <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="CSVFormat.Predefined.html#Excel"><code>CSVFormat.Predefined.Excel</code></a></li> +<li><a href="DuplicateHeaderMode.html#ALLOW_ALL"><code>DuplicateHeaderMode.ALLOW_ALL</code></a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="INFORMIX_UNLOAD"> <h3>INFORMIX_UNLOAD</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1052">INFORMIX_UNLOAD</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1069">INFORMIX_UNLOAD</a></span></div> <div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation. <p> @@ -879,32 +995,34 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setEscape('\\')</code></li> - <li><code>setQuote("\"")</code></li> - <li><code>setRecordSeparator('\n')</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('\\')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('\"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(char)"><code>setRecordSeparator</code></a><code>('\n')</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.3</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a></li> <li><a href="http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm";> http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="INFORMIX_UNLOAD_CSV"> <h3>INFORMIX_UNLOAD_CSV</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1083">INFORMIX_UNLOAD_CSV</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1100">INFORMIX_UNLOAD_CSV</a></span></div> <div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation (escaping is disabled.) <p> @@ -913,31 +1031,33 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setQuote("\"")</code></li> - <li><code>setRecordSeparator('\n')</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('\"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(char)"><code>setRecordSeparator</code></a><code>('\n')</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.3</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a></li> <li><a href="http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm";> http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="MONGODB_CSV"> <h3>MONGODB_CSV</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1122">MONGODB_CSV</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1139">MONGODB_CSV</a></span></div> <div class="block">Default MongoDB CSV format used by the <code>mongoexport</code> operation. <p> <strong>Parsing is not supported yet.</strong> @@ -954,32 +1074,34 @@ implements <a href="https://docs.oracle. not a valid escape character. If you use double-quotes to enclose fields in the CSV data, you must escape internal double-quote marks by prepending another double-quote. </blockquote> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setEscape('"')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> - <li><code>setSkipHeaderRecord(false)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.ALL_NON_NULL)</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.7</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MongoDBCsv"><code>CSVFormat.Predefined.MongoDBCsv</code></a></li> +<li><a href="QuoteMode.html#ALL_NON_NULL"><code>QuoteMode.ALL_NON_NULL</code></a></li> <li><a href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB mongoexport command documentation</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="MONGODB_TSV"> <h3>MONGODB_TSV</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1159">MONGODB_TSV</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1176">MONGODB_TSV</a></span></div> <div class="block">Default MongoDB TSV format used by the <code>mongoexport</code> operation. <p> <strong>Parsing is not supported yet.</strong> @@ -991,13 +1113,13 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter('\t')</code></li> - <li><code>setEscape('"')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>('\t')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.ALL_NON_NULL)</code></li> <li><code>setSkipHeaderRecord(false)</code></li> </ul></div> <dl class="notes"> @@ -1005,19 +1127,22 @@ implements <a href="https://docs.oracle. <dd>1.7</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MongoDBCsv"><code>CSVFormat.Predefined.MongoDBCsv</code></a></li> +<li><a href="QuoteMode.html#ALL_NON_NULL"><code>QuoteMode.ALL_NON_NULL</code></a></li> <li><a href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB mongoexport command documentation</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="MYSQL"> <h3>MYSQL</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1194">MYSQL</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1212">MYSQL</a></span></div> <div class="block">Default MySQL format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA INFILE</code> operations. <p> @@ -1026,33 +1151,36 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter('\t')</code></li> - <li><code>setEscape('\\')</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> - <li><code>setQuote(null)</code></li> - <li><code>setRecordSeparator('\n')</code></li> - <li><code>setNullString("\\N")</code></li> - <li><code>setQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>('\t')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('\\')</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(java.lang.Character)"><code>setQuote</code></a><code>(null)</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(char)"><code>setRecordSeparator</code></a><code>('\n')</code></li> + <li><a href="CSVFormat.Builder.html#setNullString(java.lang.String)"><code>setNullString</code></a><code>("\\N")</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.ALL_NON_NULL)</code></li> </ul></div> <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a></li> +<li><a href="QuoteMode.html#ALL_NON_NULL"><code>QuoteMode.ALL_NON_NULL</code></a></li> <li><a href="https://dev.mysql.com/doc/refman/5.1/en/load-data.html";> https://dev.mysql.com/doc/refman/5.1/en/load -data.html</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="ORACLE"> <h3>ORACLE</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1233">ORACLE</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1252">ORACLE</a></span></div> <div class="block">Default Oracle format used by the SQL*Loader utility. <p> @@ -1062,35 +1190,38 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',') // default is {@code FIELDS TERMINATED BY ','}</code></li> - <li><code>setEscape('\\')</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> - <li><code>setQuote('"') // default is {@code OPTIONALLY ENCLOSED BY '"'}</code></li> - <li><code>setNullString("\\N")</code></li> - <li><code>setTrim()</code></li> - <li><code>setSystemRecordSeparator()</code></li> - <li><code>setQuoteMode(QuoteMode.MINIMAL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code> // default is <code>FIELDS TERMINATED BY ','</code>}</li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('\\')</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code> // default is <code>OPTIONALLY ENCLOSED BY '"'</code>}</li> + <li><a href="CSVFormat.Builder.html#setNullString(java.lang.String)"><code>setNullString</code></a><code>("\\N")</code></li> + <li><a href="CSVFormat.Builder.html#setTrim(boolean)"><code>setTrim</code></a><code>(true)</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(java.lang.String)"><code>setRecordSeparator</code></a><code>(System.lineSeparator())</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.MINIMAL)</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.6</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#Oracle"><code>CSVFormat.Predefined.Oracle</code></a></li> +<li><a href="QuoteMode.html#MINIMAL"><code>QuoteMode.MINIMAL</code></a></li> <li><a href="https://s.apache.org/CGXG";>Oracle CSV Format Specification</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="POSTGRESQL_CSV"> <h3>POSTGRESQL_CSV</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1272">POSTGRESQL_CSV</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1292">POSTGRESQL_CSV</a></span></div> <div class="block">Default PostgreSQL CSV format used by the <code>COPY</code> operation. <p> @@ -1099,35 +1230,38 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setEscape(null)</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setRecordSeparator('\n')</code></li> - <li><code>setNullString("")</code></li> - <li><code>setQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(java.lang.Character)"><code>setEscape</code></a><code>(null)</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(char)"><code>setRecordSeparator</code></a><code>('\n')</code></li> + <li><a href="CSVFormat.Builder.html#setNullString(java.lang.String)"><code>setNullString</code></a><code>("")</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.ALL_NON_NULL)</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.5</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a></li> +<li><a href="QuoteMode.html#ALL_NON_NULL"><code>QuoteMode.ALL_NON_NULL</code></a></li> <li><a href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL COPY command documentation</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="POSTGRESQL_TEXT"> <h3>POSTGRESQL_TEXT</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1310">POSTGRESQL_TEXT</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1331">POSTGRESQL_TEXT</a></span></div> <div class="block">Default PostgreSQL text format used by the <code>COPY</code> operation. <p> @@ -1136,79 +1270,83 @@ implements <a href="https://docs.oracle. </p> <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter('\t')</code></li> - <li><code>setEscape('\\')</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> - <li><code>setQuote(null)</code></li> - <li><code>setRecordSeparator('\n')</code></li> - <li><code>setNullString("\\N")</code></li> - <li><code>setQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>('\t')</code></li> + <li><a href="CSVFormat.Builder.html#setEscape(char)"><code>setEscape</code></a><code>('\\')</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(java.lang.Character)"><code>setQuote</code></a><code>(null)</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(char)"><code>setRecordSeparator</code></a><code>('\n')</code></li> + <li><a href="CSVFormat.Builder.html#setNullString(java.lang.String)"><code>setNullString</code></a><code>("\\N")</code></li> + <li><a href="CSVFormat.Builder.html#setQuoteMode(org.apache.commons.csv.QuoteMode)"><code>setQuoteMode</code></a><code>(QuoteMode.ALL_NON_NULL)</code></li> </ul></div> <dl class="notes"> <dt>Since:</dt> <dd>1.5</dd> <dt>See Also:</dt> <dd> -<ul class="see-list-long"> +<ul class="tag-list-long"> <li><a href="CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a></li> +<li><a href="QuoteMode.html#ALL_NON_NULL"><code>QuoteMode.ALL_NON_NULL</code></a></li> <li><a href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL COPY command documentation</a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="RFC4180"> <h3>RFC4180</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1336">RFC4180</a></span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1357">RFC4180</a></span></div> <div class="block">Comma separated format as defined by <a href="https://tools.ietf.org/html/rfc4180";>RFC 4180</a>. <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter(',')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setRecordSeparator("\r\n")</code></li> - <li><code>setIgnoreEmptyLines(false)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>(',')</code></li> + <li><a href="CSVFormat.Builder.html#setQuote(char)"><code>setQuote</code></a><code>('"')</code></li> + <li><a href="CSVFormat.Builder.html#setRecordSeparator(java.lang.String)"><code>setRecordSeparator</code></a><code>("\r\n")</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreEmptyLines(boolean)"><code>setIgnoreEmptyLines</code></a><code>(false)</code></li> </ul></div> <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="CSVFormat.Predefined.html#RFC4180"><code>CSVFormat.Predefined.RFC4180</code></a></li> </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="TDF"> <h3>TDF</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1356">TDF</a></span></div> -<div class="block">Tab-delimited format. +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1375">TDF</a></span></div> +<div class="block">Tab-delimited format (TDF). <p> - The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are: + The <a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv"><code>CSVFormat.Builder</code></a> settings are the <a href="#DEFAULT"><code>DEFAULT</code></a> <em>with</em>: </p> <ul> - <li><code>setDelimiter('\t')</code></li> - <li><code>setQuote('"')</code></li> - <li><code>setRecordSeparator("\r\n")</code></li> - <li><code>setIgnoreSurroundingSpaces(true)</code></li> + <li><a href="CSVFormat.Builder.html#setDelimiter(char)"><code>setDelimiter</code></a><code>('\t')</code></li> + <li><a href="CSVFormat.Builder.html#setIgnoreSurroundingSpaces(boolean)"><code>setIgnoreSurroundingSpaces</code></a><code>(true)</code></li> </ul></div> <dl class="notes"> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="CSVFormat.Predefined.html#TDF"><code>CSVFormat.Predefined.TDF</code></a></li> </ul> </dd> </dl> +</div> </section> </li> </ul> @@ -1222,7 +1360,8 @@ implements <a href="https://docs.oracle. <li> <section class="detail" id="newFormat(char)"> <h3>newFormat</h3> -<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1454">newFormat</a></span><wbr><span class="parameters">(char delimiter)</span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1473">newFormat</a></span><wbr><span class="parameters">(char delimiter)</span></div> <div class="block">Creates a new CSV format with the specified delimiter. <p> @@ -1237,7 +1376,7 @@ implements <a href="https://docs.oracle. <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> - if the delimiter is a line break character</dd> <dt>See Also:</dt> <dd> -<ul class="see-list"> +<ul class="tag-list"> <li><a href="#DEFAULT"><code>DEFAULT</code></a></li> <li><a href="#RFC4180"><code>RFC4180</code></a></li> <li><a href="#MYSQL"><code>MYSQL</code></a></li> @@ -1246,12 +1385,14 @@ implements <a href="https://docs.oracle. </ul> </dd> </dl> +</div> </section> </li> <li> <section class="detail" id="valueOf(java.lang.String)"> <h3>valueOf</h3> -<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1491">valueOf</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> format)</span></div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1510">valueOf</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> format)</span></div> <div class="block">Gets one of the predefined formats from <a href="CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><code>CSVFormat.Predefined</code></a>.</div> <dl class="notes"> <dt>Parameters:</dt> @@ -1261,33 +1402,39 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.2</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="builder()"> <h3>builder</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv">CSVFormat.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1604">builder</a></span>()</div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVFormat.Builder.html" title="class in org.apache.commons.csv">CSVFormat.Builder</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1623">builder</a></span>()</div> <div class="block">Creates a new Builder for this instance.</div> <dl class="notes"> <dt>Returns:</dt> <dd>a new Builder.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="equals(java.lang.Object)"> <h3>equals</h3> -<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/CSVFormat.html#line-1617">equals</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> obj)</span></div> +<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/CSVFormat.html#line-1636">equals</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> obj)</span></div> <dl class="notes"> <dt>Overrides:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><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></code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="format(java.lang.Object...)"> <h3>format</h3> -<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/CSVFormat.html#line-1652">format</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></div> +<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/CSVFormat.html#line-1671">format</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></div> <div class="block">Formats the specified values.</div> <dl class="notes"> <dt>Parameters:</dt> @@ -1295,13 +1442,15 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>the formatted values</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getAllowDuplicateHeaderNames()"> <h3>getAllowDuplicateHeaderNames</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="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1673">getAllowDuplicateHeaderNames</a></span>()</div> +</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1692">getAllowDuplicateHeaderNames</a></span>()</div> <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> <div class="deprecation-comment">Use <a href="#getDuplicateHeaderMode()"><code>getDuplicateHeaderMode()</code></a>.</div> </div> @@ -1312,23 +1461,27 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.7</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getAllowMissingColumnNames()"> <h3>getAllowMissingColumnNames</h3> -<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/CSVFormat.html#line-1683">getAllowMissingColumnNames</a></span>()</div> +<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/CSVFormat.html#line-1702">getAllowMissingColumnNames</a></span>()</div> <div class="block">Gets whether missing column names are allowed when parsing the header line.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if missing column names are allowed when parsing the header line, <code>false</code> to throw an <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"><code>IllegalArgumentException</code></a>.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getAutoFlush()"> <h3>getAutoFlush</h3> -<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/CSVFormat.html#line-1693">getAutoFlush</a></span>()</div> +<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/CSVFormat.html#line-1712">getAutoFlush</a></span>()</div> <div class="block">Gets whether to flush on close.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1336,12 +1489,14 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.6</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getCommentMarker()"> <h3>getCommentMarker</h3> -<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1730">getCommentMarker</a></span>()</div> +<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1749">getCommentMarker</a></span>()</div> <div class="block">Gets the comment marker character, <code>null</code> disables comments. <p> The comment start character is only recognized at the start of a line. @@ -1375,13 +1530,15 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>the comment start marker, may be <code>null</code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getDelimiter()"> <h3>getDelimiter</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="return-type">char</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1740">getDelimiter</a></span>()</div> +</span><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1759">getDelimiter</a></span>()</div> <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> <div class="deprecation-comment">Use <a href="#getDelimiterString()"><code>getDelimiterString()</code></a>.</div> </div> @@ -1390,12 +1547,14 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>the first delimiter character.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getDelimiterString()"> <h3>getDelimiterString</h3> -<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/CSVFormat.html#line-1760">getDelimiterString</a></span>()</div> +<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/CSVFormat.html#line-1779">getDelimiterString</a></span>()</div> <div class="block">Gets the character delimiting the values (typically ";", "," or "\t").</div> <dl class="notes"> <dt>Returns:</dt> @@ -1403,12 +1562,14 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.9.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getDuplicateHeaderMode()"> <h3>getDuplicateHeaderMode</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DuplicateHeaderMode.html" title="enum in org.apache.commons.csv">DuplicateHeaderMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1770">getDuplicateHeaderMode</a></span>()</div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DuplicateHeaderMode.html" title="enum in org.apache.commons.csv">DuplicateHeaderMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1789">getDuplicateHeaderMode</a></span>()</div> <div class="block">Gets how duplicate headers are handled.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1416,34 +1577,40 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.10.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getEscapeCharacter()"> <h3>getEscapeCharacter</h3> -<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1788">getEscapeCharacter</a></span>()</div> +<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1807">getEscapeCharacter</a></span>()</div> <div class="block">Gets the escape character.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the escape character, may be <code>null</code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getHeader()"> <h3>getHeader</h3> -<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/CSVFormat.html#line-1797">getHeader</a></span>()</div> +<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/CSVFormat.html#line-1816">getHeader</a></span>()</div> <div class="block">Gets a copy of the header array.</div> <dl class="notes"> <dt>Returns:</dt> <dd>a copy of the header array; <code>null</code> if disabled, the empty array if to be read from the file</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getHeaderComments()"> <h3>getHeaderComments</h3> -<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/CSVFormat.html#line-1834">getHeaderComments</a></span>()</div> +<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/CSVFormat.html#line-1853">getHeaderComments</a></span>()</div> <div class="block">Gets a copy of the header comment array to write before the CSV data. <p> This setting is ignored by the parser. @@ -1477,23 +1644,27 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>a copy of the header comment array; <code>null</code> if disabled.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getIgnoreEmptyLines()"> <h3>getIgnoreEmptyLines</h3> -<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/CSVFormat.html#line-1843">getIgnoreEmptyLines</a></span>()</div> +<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/CSVFormat.html#line-1862">getIgnoreEmptyLines</a></span>()</div> <div class="block">Gets whether empty lines between records are ignored when parsing input.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if empty lines between records are ignored, <code>false</code> if they are turned into empty records.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getIgnoreHeaderCase()"> <h3>getIgnoreHeaderCase</h3> -<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/CSVFormat.html#line-1853">getIgnoreHeaderCase</a></span>()</div> +<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/CSVFormat.html#line-1872">getIgnoreHeaderCase</a></span>()</div> <div class="block">Gets whether header names will be accessed ignoring case when parsing input.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1501,23 +1672,27 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.3</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getIgnoreSurroundingSpaces()"> <h3>getIgnoreSurroundingSpaces</h3> -<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/CSVFormat.html#line-1862">getIgnoreSurroundingSpaces</a></span>()</div> +<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/CSVFormat.html#line-1881">getIgnoreSurroundingSpaces</a></span>()</div> <div class="block">Gets whether spaces around values are ignored when parsing input.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if spaces around values are ignored, <code>false</code> if they are treated as part of the value.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getLenientEof()"> <h3>getLenientEof</h3> -<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/CSVFormat.html#line-1872">getLenientEof</a></span>()</div> +<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/CSVFormat.html#line-1891">getLenientEof</a></span>()</div> <div class="block">Gets whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1525,12 +1700,14 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.11.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getNullString()"> <h3>getNullString</h3> -<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/CSVFormat.html#line-1885">getNullString</a></span>()</div> +<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/CSVFormat.html#line-1904">getNullString</a></span>()</div> <div class="block">Gets the String to convert to and from <code>null</code>. <ul> <li><strong>Reading:</strong> Converts strings equal to the given <code>nullString</code> to <code>null</code> when reading records.</li> @@ -1540,56 +1717,66 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd>the String to convert to and from <code>null</code>. No substitution occurs if <code>null</code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getQuoteCharacter()"> <h3>getQuoteCharacter</h3> -<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1894">getQuoteCharacter</a></span>()</div> +<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/Character.html"; title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1913">getQuoteCharacter</a></span>()</div> <div class="block">Gets the character used to encapsulate values containing special characters.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the quoteChar character, may be <code>null</code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getQuoteMode()"> <h3>getQuoteMode</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1903">getQuoteMode</a></span>()</div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1922">getQuoteMode</a></span>()</div> <div class="block">Gets the quote policy output fields.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the quote policy</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getRecordSeparator()"> <h3>getRecordSeparator</h3> -<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/CSVFormat.html#line-1912">getRecordSeparator</a></span>()</div> +<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/CSVFormat.html#line-1931">getRecordSeparator</a></span>()</div> <div class="block">Gets the record separator delimiting output records.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the record separator</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getSkipHeaderRecord()"> <h3>getSkipHeaderRecord</h3> -<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/CSVFormat.html#line-1921">getSkipHeaderRecord</a></span>()</div> +<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/CSVFormat.html#line-1940">getSkipHeaderRecord</a></span>()</div> <div class="block">Gets whether to skip the header record.</div> <dl class="notes"> <dt>Returns:</dt> <dd>whether to skip the header record.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getTrailingData()"> <h3>getTrailingData</h3> -<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/CSVFormat.html#line-1931">getTrailingData</a></span>()</div> +<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/CSVFormat.html#line-1950">getTrailingData</a></span>()</div> <div class="block">Gets whether reading trailing data is allowed in records, helps Excel compatibility.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1597,12 +1784,14 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.11.0</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getTrailingDelimiter()"> <h3>getTrailingDelimiter</h3> -<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/CSVFormat.html#line-1941">getTrailingDelimiter</a></span>()</div> +<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/CSVFormat.html#line-1960">getTrailingDelimiter</a></span>()</div> <div class="block">Gets whether to add a trailing delimiter.</div> <dl class="notes"> <dt>Returns:</dt> @@ -1610,33 +1799,39 @@ implements <a href="https://docs.oracle. <dt>Since:</dt> <dd>1.3</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="getTrim()"> <h3>getTrim</h3> -<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/CSVFormat.html#line-1950">getTrim</a></span>()</div> +<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/CSVFormat.html#line-1969">getTrim</a></span>()</div> <div class="block">Gets whether to trim leading and trailing blanks. This is used by <a href="#print(java.lang.Object,java.lang.Appendable,boolean)"><code>print(Object, Appendable, boolean)</code></a> Also by {CSVParser#addRecordValue(boolean)}</div> <dl class="notes"> <dt>Returns:</dt> <dd>whether to trim leading and trailing blanks.</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="hashCode()"> <h3>hashCode</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1954">hashCode</a></span>()</div> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-1973">hashCode</a></span>()</div> <dl class="notes"> <dt>Overrides:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><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></code></dd> </dl> +</div> </section> </li> <li> <section class="detail" id="isCommentMarkerSet()"> <h3>isCommentMarkerSet</h3> -<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/CSVFormat.html#line-1973">isCommentMarkerSet</a></span>()</div> +<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/CSVFormat.html#line-1992">isCommentMarkerSet</a></span>()</div> <div class="block">Tests whether comments are supported by this format. Note that the comment introducer character is only recognized at the start of a line.</div> @@ -1644,45 +1839,53 @@ implements <a href="https://docs.oracle. <dt>Returns:</dt> <dd><code>true</code> is comments are supported, <code>false</code> otherwise</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="isEscapeCharacterSet()"> <h3>isEscapeCharacterSet</h3> -<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/CSVFormat.html#line-2008">isEscapeCharacterSet</a></span>()</div> +<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/CSVFormat.html#line-2027">isEscapeCharacterSet</a></span>()</div> <div class="block">Tests whether escapes are being processed.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if escapes are processed</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="isNullStringSet()"> <h3>isNullStringSet</h3> -<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/CSVFormat.html#line-2017">isNullStringSet</a></span>()</div> +<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/CSVFormat.html#line-2036">isNullStringSet</a></span>()</div> <div class="block">Tests whether a null string has been defined.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if a nullString is defined</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="isQuoteCharacterSet()"> <h3>isQuoteCharacterSet</h3> -<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/CSVFormat.html#line-2026">isQuoteCharacterSet</a></span>()</div> +<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/CSVFormat.html#line-2045">isQuoteCharacterSet</a></span>()</div> <div class="block">Tests whether a quoteChar has been defined.</div> <dl class="notes"> <dt>Returns:</dt> <dd><code>true</code> if a quoteChar is defined</dd> </dl> +</div> </section> </li> <li> <section class="detail" id="parse(java.io.Reader)"> <h3>parse</h3> -<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/CSVFormat.html#line-2042">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)</span> +<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/CSVFormat.html#line-2061">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)</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">Parses the specified content. @@ -1698,12 +1901,14 @@ 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="print(java.lang.Appendable)"> <h3>print</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-2057">print</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> out)</span> +<div class="horizontal-scroll"> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line-2076">print</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> out)</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>
[... 793 lines stripped ...]
