Modified:
websites/production/commons/content/proper/commons-csv/apidocs/index-all.html
==============================================================================
---
websites/production/commons/content/proper/commons-csv/apidocs/index-all.html
(original)
+++
websites/production/commons/content/proper/commons-csv/apidocs/index-all.html
Wed Mar 19 22:20:06 2025
@@ -1,59 +1,57 @@
<!DOCTYPE HTML>
<html lang>
<head>
-<!-- Generated by javadoc (23) -->
-<title>Index (Apache Commons CSV 1.13.1-SNAPSHOT API)</title>
+<!-- Generated by javadoc (17) -->
+<title>Index (Apache Commons CSV 1.14.0 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="index">
<meta name="generator" content="javadoc/IndexWriter">
-<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>
+<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>
</head>
<body class="index-page">
-<script type="text/javascript">const pathtoroot = "./";
+<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
-<header role="banner">
+<div class="flex-box">
+<header role="banner" class="flex-header">
<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="index.html">Overview</a></li>
<li><a href="org/apache/commons/csv/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
<li><a href="org/apache/commons/csv/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="nav-bar-cell1-rev">Index</li>
-<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#index">Help</a></li>
</ul>
</div>
-</div>
<div class="sub-nav">
-<div class="nav-content">
-<ol class="sub-nav-list"></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="main-grid">
+<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
-<a href="#I:A">A</a> <a href="#I:B">B</a> <a
href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a
href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a
href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a
href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a
href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a
href="#I:U">U</a> <a href="#I:V">V</a> <a
href="#I:W">W</a> <br><a
href="allclasses-index.html">All Classes and Interfaces</a><span
class="vertical-separator">|</span><a
href="allpackages-index.html">All Packages</a><span
class="vertical-separator">|</span><a
href="serialized-form.html">Serialized Form</a>
+<a href="#I:A">A</a> <a href="#I:B">B</a> <a
href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a
href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a
href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a
href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a
href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a
href="#I:V">V</a> <a href="#I:W">W</a> <br><a
href="allclasses-index.html">All Classes and Interfaces</a><span
class="vertical-separator">|</span><a
href="allpackages-index.html">All Packages</a><span
class="vertical-separator">|</span><a
href="serialized-form.html">Serialized Form</a>
<h2 class="title" id="I:A">A</h2>
<dl class="index">
<dt><a href="org/apache/commons/csv/QuoteMode.html#ALL"
class="member-name-link">ALL</a> - Enum constant in enum
org.apache.commons.csv.<a href="org/apache/commons/csv/QuoteMode.html"
title="enum in org.apache.commons.csv">QuoteMode</a></dt>
@@ -72,8 +70,6 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Allows duplicate headers only if they're empty, blank, or
null strings.</div>
</dd>
-<dt><a
href="org/apache/commons/csv/package-summary.html#apache-commons-csv-heading"
class="search-tag-link">Apache Commons CSV</a> - Search tag in package
org.apache.commons.csv</dt>
-<dd>Section</dd>
</dl>
<h2 class="title" id="I:B">B</h2>
<dl class="index">
@@ -116,13 +112,11 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Creates a new builder from the given format.</div>
</dd>
-<dt><a href="org/apache/commons/csv/CSVParser.html#creating-instances-heading"
class="search-tag-link">Creating instances</a> - Search tag in class
org.apache.commons.csv.CSVParser</dt>
-<dd>Section</dd>
-<dt><a href="org/apache/commons/csv/CSVException.html" class="type-name-link"
title="class in org.apache.commons.csv">CSVException</a> - Exception Class in
<a
href="org/apache/commons/csv/package-summary.html">org.apache.commons.csv</a></dt>
+<dt><a href="org/apache/commons/csv/CSVException.html" class="type-name-link"
title="class in org.apache.commons.csv">CSVException</a> - Exception in <a
href="org/apache/commons/csv/package-summary.html">org.apache.commons.csv</a></dt>
<dd>
<div class="block">Signals a CSV exception.</div>
</dd>
-<dt><a
href="org/apache/commons/csv/CSVException.html#%3Cinit%3E(java.lang.String,java.lang.Object...)"
class="member-name-link">CSVException(String, Object...)</a> - Constructor for
exception class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVException.html" title="class in
org.apache.commons.csv">CSVException</a></dt>
+<dt><a
href="org/apache/commons/csv/CSVException.html#%3Cinit%3E(java.lang.String,java.lang.Object...)"
class="member-name-link">CSVException(String, Object...)</a> - Constructor for
exception org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVException.html" title="class in
org.apache.commons.csv">CSVException</a></dt>
<dd>
<div class="block">Constructs a new instance with a formatted message.</div>
</dd>
@@ -151,7 +145,7 @@ loadScripts(document, 'script');</script
<dt><a
href="org/apache/commons/csv/CSVParser.html#%3Cinit%3E(java.io.Reader,org.apache.commons.csv.CSVFormat,long,long)"
class="member-name-link">CSVParser(Reader, CSVFormat, long, long)</a> -
Constructor for class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></dt>
<dd>
<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span>
-<div class="deprecation-comment">Will be private in the next major version,
use <a
href="org/apache/commons/csv/CSVParser.Builder.html#get()"><code>CSVParser.Builder.get()</code></a>.</div>
+<div class="deprecation-comment">Will be removed in the next major version,
use <a
href="org/apache/commons/csv/CSVParser.Builder.html#get()"><code>CSVParser.Builder.get()</code></a>.</div>
</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVParser.Builder.html"
class="type-name-link" title="class in
org.apache.commons.csv">CSVParser.Builder</a> - Class in <a
href="org/apache/commons/csv/package-summary.html">org.apache.commons.csv</a></dt>
@@ -181,10 +175,6 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Standard Comma Separated Value format, as for <a
href="org/apache/commons/csv/CSVFormat.html#RFC4180"><code>CSVFormat.RFC4180</code></a>
but allowing empty lines.</div>
</dd>
-<dt><a
href="org/apache/commons/csv/CSVFormat.html#defining-column-names-heading"
class="search-tag-link">Defining column names</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
-<dt><a href="org/apache/commons/csv/CSVFormat.html#defining-formats-heading"
class="search-tag-link">Defining formats</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
<dt><a href="org/apache/commons/csv/DuplicateHeaderMode.html#DISALLOW"
class="member-name-link">DISALLOW</a> - Enum constant in enum
org.apache.commons.csv.<a
href="org/apache/commons/csv/DuplicateHeaderMode.html" title="enum in
org.apache.commons.csv">DuplicateHeaderMode</a></dt>
<dd>
<div class="block">Disallows duplicate headers entirely.</div>
@@ -205,7 +195,8 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#EXCEL"
class="member-name-link">EXCEL</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Excel file format (using a comma as the value
delimiter).</div>
+<div class="block"><a
href="https://support.microsoft.com/en-us/office/import-or-export-text-txt-or-csv-files-5250ac4c-663c-47ce-937b-339e391393ba";>Microsoft
Excel</a> file
+ format (using a comma as the value delimiter).</div>
</dd>
</dl>
<h2 class="title" id="I:F">F</h2>
@@ -216,7 +207,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.html#format(java.lang.Object...)"
class="member-name-link">format(Object...)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Formats the specified values.</div>
+<div class="block">Formats the specified values as a CSV record string.</div>
</dd>
</dl>
<h2 class="title" id="I:G">G</h2>
@@ -233,7 +224,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVRecord.html#get(java.lang.Enum)"
class="member-name-link">get(Enum<?>)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv">CSVRecord</a></dt>
<dd>
-<div class="block">Returns a value by <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html";
title="class or interface in java.lang"
class="external-link"><code>Enum</code></a>.</div>
+<div class="block">Returns a value by <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html";
title="class or interface in java.lang"
class="external-link"><code>Enum</code></a>.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVRecord.html#get(java.lang.String)"
class="member-name-link">get(String)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv">CSVRecord</a></dt>
<dd>
@@ -335,6 +326,10 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Gets whether reading end-of-file is allowed even when input
is malformed, helps Excel compatibility.</div>
</dd>
+<dt><a href="org/apache/commons/csv/CSVFormat.html#getMaxRows()"
class="member-name-link">getMaxRows()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
+<dd>
+<div class="block">Gets the maximum number of rows to process, excluding the
header row.</div>
+</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#getNullString()"
class="member-name-link">getNullString()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
<div class="block">Gets the String to convert to and from
<code>null</code>.</div>
@@ -418,11 +413,13 @@ loadScripts(document, 'script');</script
<dl class="index">
<dt><a href="org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD"
class="member-name-link">INFORMIX_UNLOAD</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD
TO file_name</code> operation.</div>
+<div class="block">Default <a
href="https://www.ibm.com/docs/en/informix-servers/14.10?topic=statements-unload-statement";>Informix
CSV UNLOAD</a>
+ format used by the <code>UNLOAD TO file_name</code> operation.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD_CSV"
class="member-name-link">INFORMIX_UNLOAD_CSV</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD
TO file_name</code> operation (escaping is disabled.)</div>
+<div class="block">Default <a
href="https://www.ibm.com/docs/en/informix-servers/14.10?topic=statements-unload-statement";>Informix
CSV UNLOAD</a>
+ format used by the <code>UNLOAD TO file_name</code> operation (escaping is
disabled.)</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.Predefined.html#InformixUnload"
class="member-name-link">InformixUnload</a> - Enum constant in enum
org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in
org.apache.commons.csv">CSVFormat.Predefined</a></dt>
<dd>
@@ -450,7 +447,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVRecord.html#isMapped(java.lang.String)"
class="member-name-link">isMapped(String)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv">CSVRecord</a></dt>
<dd>
-<div class="block">Checks whether a given column is mapped, i.e. its name has
been defined to the parser.</div>
+<div class="block">Checks whether a given column is mapped, that is, its name
has been defined to the parser.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#isNullStringSet()"
class="member-name-link">isNullStringSet()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
@@ -506,7 +503,8 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#MYSQL"
class="member-name-link">MYSQL</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default MySQL format used by the <code>SELECT INTO
OUTFILE</code> and <code>LOAD DATA INFILE</code> operations.</div>
+<div class="block">Default <a
href="https://dev.mysql.com/doc/refman/8.0/en/mysqldump-delimited-text.html";>MySQL</a>
+ format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA
INFILE</code> operations.</div>
</dd>
</dl>
<h2 class="title" id="I:N">N</h2>
@@ -523,10 +521,6 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Never quotes fields.</div>
</dd>
-<dt><a href="org/apache/commons/csv/CSVFormat.html#notes-heading"
class="search-tag-link">Notes</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
-<dt><a href="org/apache/commons/csv/CSVParser.html#notes-heading"
class="search-tag-link">Notes</a> - Search tag in class
org.apache.commons.csv.CSVParser</dt>
-<dd>Section</dd>
</dl>
<h2 class="title" id="I:O">O</h2>
<dl class="index">
@@ -536,7 +530,9 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#ORACLE"
class="member-name-link">ORACLE</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default Oracle format used by the SQL*Loader utility.</div>
+<div class="block">Default
+ <a
href="https://docs.oracle.com/en/database/oracle/oracle-database/23/sutil/oracle-sql-loader-control-file-contents.html#GUID-D1762699-8154-40F6-90DE-EFB8EB6A9AB0";>Oracle</a>
+ format used by the SQL*Loader utility.</div>
</dd>
<dt><a
href="org/apache/commons/csv/package-summary.html">org.apache.commons.csv</a> -
package org.apache.commons.csv</dt>
<dd>
@@ -547,7 +543,7 @@ loadScripts(document, 'script');</script
<dl class="index">
<dt><a
href="org/apache/commons/csv/CSVParser.html#parse(java.io.File,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"
class="member-name-link">parse(File, Charset, CSVFormat)</a> - Static method
in class org.apache.commons.csv.<a href="org/apache/commons/csv/CSVParser.html"
title="class in org.apache.commons.csv">CSVParser</a></dt>
<dd>
-<div class="block">Creates a parser for the given <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"><code>File</code></a>.</div>
+<div class="block">Creates a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link"><code>File</code></a>.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVParser.html#parse(java.io.InputStream,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"
class="member-name-link">parse(InputStream, Charset, CSVFormat)</a> - Static
method in class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVParser.html" title="class in
org.apache.commons.csv">CSVParser</a></dt>
<dd>
@@ -563,7 +559,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVParser.html#parse(java.lang.String,org.apache.commons.csv.CSVFormat)"
class="member-name-link">parse(String, CSVFormat)</a> - Static method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVParser.html"
title="class in org.apache.commons.csv">CSVParser</a></dt>
<dd>
-<div class="block">Creates a parser for the given <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"><code>String</code></a>.</div>
+<div class="block">Creates a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link"><code>String</code></a>.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVParser.html#parse(java.net.URL,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"
class="member-name-link">parse(URL, Charset, CSVFormat)</a> - Static method in
class org.apache.commons.csv.<a href="org/apache/commons/csv/CSVParser.html"
title="class in org.apache.commons.csv">CSVParser</a></dt>
<dd>
@@ -571,21 +567,15 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVParser.html#parse(java.nio.file.Path,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat)"
class="member-name-link">parse(Path, Charset, CSVFormat)</a> - Static method
in class org.apache.commons.csv.<a href="org/apache/commons/csv/CSVParser.html"
title="class in org.apache.commons.csv">CSVParser</a></dt>
<dd>
-<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 class="block">Creates and returns a parser for the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html";
title="class or interface in java.nio.file"
class="external-link"><code>Path</code></a>, which the caller MUST close.</div>
</dd>
-<dt><a href="org/apache/commons/csv/CSVFormat.html#parsing-heading"
class="search-tag-link">Parsing</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
-<dt><a
href="org/apache/commons/csv/CSVParser.html#parsing-into-memory-heading"
class="search-tag-link">Parsing into memory</a> - Search tag in class
org.apache.commons.csv.CSVParser</dt>
-<dd>Section</dd>
-<dt><a
href="org/apache/commons/csv/CSVParser.html#parsing-record-wise-heading"
class="search-tag-link">Parsing record wise</a> - Search tag in class
org.apache.commons.csv.CSVParser</dt>
-<dd>Section</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#POSTGRESQL_CSV"
class="member-name-link">POSTGRESQL_CSV</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default PostgreSQL CSV format used by the <code>COPY</code>
operation.</div>
+<div class="block">Default <a
href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL
CSV</a> format used by the <code>COPY</code> operation.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#POSTGRESQL_TEXT"
class="member-name-link">POSTGRESQL_TEXT</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Default PostgreSQL text format used by the
<code>COPY</code> operation.</div>
+<div class="block">Default <a
href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL
Text</a> format used by the <code>COPY</code> operation.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.Predefined.html#PostgreSQLCsv"
class="member-name-link">PostgreSQLCsv</a> - Enum constant in enum
org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in
org.apache.commons.csv">CSVFormat.Predefined</a></dt>
<dd>
@@ -621,7 +611,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#printer()"
class="member-name-link">printer()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Prints to the <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/System.html#out";
title="class or interface in java.lang"
class="external-link"><code>System.out</code></a>.</div>
+<div class="block">Prints to the <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out";
title="class or interface in java.lang"
class="external-link"><code>System.out</code></a>.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVPrinter.html#printHeaders(java.sql.ResultSet)"
class="member-name-link">printHeaders(ResultSet)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVPrinter.html"
title="class in org.apache.commons.csv">CSVPrinter</a></dt>
<dd>
@@ -629,7 +619,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVPrinter.html#println()"
class="member-name-link">println()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVPrinter.html"
title="class in org.apache.commons.csv">CSVPrinter</a></dt>
<dd>
-<div class="block">Outputs the record separator.</div>
+<div class="block">Prints the record separator.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.html#println(java.lang.Appendable)"
class="member-name-link">println(Appendable)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
@@ -653,7 +643,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVPrinter.html#printRecords(java.lang.Iterable)"
class="member-name-link">printRecords(Iterable<?>)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVPrinter.html"
title="class in org.apache.commons.csv">CSVPrinter</a></dt>
<dd>
-<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.</div>
+<div class="block">Prints all the objects in the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html";
title="class or interface in java.lang"
class="external-link"><code>Iterable</code></a> handling nested
collections/arrays as records.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVPrinter.html#printRecords(java.lang.Object...)"
class="member-name-link">printRecords(Object...)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVPrinter.html"
title="class in org.apache.commons.csv">CSVPrinter</a></dt>
<dd>
@@ -669,7 +659,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVPrinter.html#printRecords(java.util.stream.Stream)"
class="member-name-link">printRecords(Stream<?>)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVPrinter.html"
title="class in org.apache.commons.csv">CSVPrinter</a></dt>
<dd>
-<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.</div>
+<div class="block">Prints all the objects in the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html";
title="class or interface in java.util.stream"
class="external-link"><code>Stream</code></a> handling nested
collections/arrays as records.</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVRecord.html#putIn(M)"
class="member-name-link">putIn(M)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv">CSVRecord</a></dt>
<dd>
@@ -685,8 +675,6 @@ loadScripts(document, 'script');</script
</dl>
<h2 class="title" id="I:R">R</h2>
<dl class="index">
-<dt><a
href="org/apache/commons/csv/CSVFormat.html#referencing-columns-safely-heading"
class="search-tag-link">Referencing columns safely</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.Predefined.html#RFC4180"
class="member-name-link">RFC4180</a> - Enum constant in enum
org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in
org.apache.commons.csv">CSVFormat.Predefined</a></dt>
<dd>
<div class="block">The RFC4180 predefined format.</div>
@@ -698,8 +686,6 @@ loadScripts(document, 'script');</script
</dl>
<h2 class="title" id="I:S">S</h2>
<dl class="index">
-<dt><a href="org/apache/commons/csv/CSVFormat.html#serialization-heading"
class="search-tag-link">Serialization</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setAllowDuplicateHeaderNames(boolean)"
class="member-name-link">setAllowDuplicateHeaderNames(boolean)</a> - Method in
class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Builder.html" title="class in
org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span>
@@ -709,7 +695,7 @@ loadScripts(document, 'script');</script
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setAllowMissingColumnNames(boolean)"
class="member-name-link">setAllowMissingColumnNames(boolean)</a> - Method in
class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Builder.html" title="class in
org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
<div class="block">Sets the parser missing column names behavior,
<code>true</code> to allow missing column names in the header line,
<code>false</code> to cause 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> to be
thrown.</div>
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html";
title="class or interface in java.lang"
class="external-link"><code>IllegalArgumentException</code></a> to be
thrown.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setAutoFlush(boolean)"
class="member-name-link">setAutoFlush(boolean)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.Builder.html"
title="class in org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
@@ -753,7 +739,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setHeader(java.lang.Class)"
class="member-name-link">setHeader(Class<? extends Enum<?>>)</a> -
Method in class org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Builder.html" title="class in
org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
-<div class="block">Sets the header defined by the given <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html";
title="class or interface in java.lang"
class="external-link"><code>Enum</code></a> class.</div>
+<div class="block">Sets the header defined by the given <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html";
title="class or interface in java.lang"
class="external-link"><code>Enum</code></a> class.</div>
</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setHeader(java.lang.String...)"
class="member-name-link">setHeader(String...)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.Builder.html"
title="class in org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
@@ -792,6 +778,10 @@ loadScripts(document, 'script');</script
<dd>
<div class="block">Sets whether reading end-of-file is allowed even when input
is malformed, helps Excel compatibility.</div>
</dd>
+<dt><a href="org/apache/commons/csv/CSVFormat.Builder.html#setMaxRows(long)"
class="member-name-link">setMaxRows(long)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.Builder.html"
title="class in org.apache.commons.csv">CSVFormat.Builder</a></dt>
+<dd>
+<div class="block">Sets the maximum number of rows to process, excluding the
header row.</div>
+</dd>
<dt><a
href="org/apache/commons/csv/CSVFormat.Builder.html#setNullString(java.lang.String)"
class="member-name-link">setNullString(String)</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.Builder.html"
title="class in org.apache.commons.csv">CSVFormat.Builder</a></dt>
<dd>
<div class="block">Sets the String to convert to and from
<code>null</code>.</div>
@@ -861,7 +851,7 @@ loadScripts(document, 'script');</script
</dd>
<dt><a href="org/apache/commons/csv/CSVFormat.html#TDF"
class="member-name-link">TDF</a> - Static variable in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVFormat.html"
title="class in org.apache.commons.csv">CSVFormat</a></dt>
<dd>
-<div class="block">Tab-delimited format (TDF).</div>
+<div class="block">Tab-delimited format (<a
href="https://en.wikipedia.org/wiki/Tab-separated_values";>TDF</a>).</div>
</dd>
<dt><a href="org/apache/commons/csv/CSVRecord.html#toList()"
class="member-name-link">toList()</a> - Method in class
org.apache.commons.csv.<a href="org/apache/commons/csv/CSVRecord.html"
title="class in org.apache.commons.csv">CSVRecord</a></dt>
<dd>
@@ -878,11 +868,6 @@ loadScripts(document, 'script');</script
<div class="block">Returns a string representation of the contents of this
record.</div>
</dd>
</dl>
-<h2 class="title" id="I:U">U</h2>
-<dl class="index">
-<dt><a
href="org/apache/commons/csv/CSVFormat.html#using-predefined-formats-heading"
class="search-tag-link">Using predefined formats</a> - Search tag in class
org.apache.commons.csv.CSVFormat</dt>
-<dd>Section</dd>
-</dl>
<h2 class="title" id="I:V">V</h2>
<dl class="index">
<dt><a
href="org/apache/commons/csv/CSVFormat.Predefined.html#valueOf(java.lang.String)"
class="member-name-link">valueOf(String)</a> - Static method in enum
org.apache.commons.csv.<a
href="org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in
org.apache.commons.csv">CSVFormat.Predefined</a></dt>
@@ -1134,12 +1119,12 @@ the order they are declared.</div>
</div>
</dd>
</dl>
-<a href="#I:A">A</a> <a href="#I:B">B</a> <a
href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a
href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a
href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a
href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a
href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a
href="#I:U">U</a> <a href="#I:V">V</a> <a
href="#I:W">W</a> <br><a
href="allclasses-index.html">All Classes and Interfaces</a><span
class="vertical-separator">|</span><a
href="allpackages-index.html">All Packages</a><span
class="vertical-separator">|</span><a
href="serialized-form.html">Serialized Form</a>
+<a href="#I:A">A</a> <a href="#I:B">B</a> <a
href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a
href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a
href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a
href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a
href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a
href="#I:V">V</a> <a href="#I:W">W</a> <br><a
href="allclasses-index.html">All Classes and Interfaces</a><span
class="vertical-separator">|</span><a
href="allpackages-index.html">All Packages</a><span
class="vertical-separator">|</span><a
href="serialized-form.html">Serialized Form</a></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>
-</main>
+</div>
</div>
</body>
</html>
\ No newline at end of file
Modified:
websites/production/commons/content/proper/commons-csv/apidocs/index.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/index.html
(original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/index.html
Wed Mar 19 22:20:06 2025
@@ -1,25 +1,422 @@
<!DOCTYPE HTML>
<html lang>
<head>
-<!-- Generated by javadoc (23) -->
-<title>Apache Commons CSV 1.13.1-SNAPSHOT API</title>
+<!-- Generated by javadoc (17) -->
+<title>Overview (Apache Commons CSV 1.14.0 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="index redirect">
-<meta name="generator" content="javadoc/IndexRedirectWriter">
-<link rel="canonical" href="org/apache/commons/csv/package-summary.html">
-<link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css"
title="Style">
-<script
type="text/javascript">window.location.replace('org/apache/commons/csv/package-summary.html')</script>
-<noscript>
-<meta http-equiv="Refresh"
content="0;org/apache/commons/csv/package-summary.html">
-</noscript>
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/PackageIndexWriter">
+<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>
</head>
-<body class="index-redirect-page">
-<main role="main">
+<body class="package-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
<noscript>
-<p>JavaScript is disabled on your browser.</p>
+<div>JavaScript is disabled on your browser.</div>
</noscript>
-<p><a
href="org/apache/commons/csv/package-summary.html">org/apache/commons/csv/package-summary.html</a></p>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<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 class="nav-bar-cell1-rev">Overview</li>
+<li><a href="org/apache/commons/csv/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="org/apache/commons/csv/package-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#overview">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<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">
+<main role="main">
+<div class="header">
+<h1 class="title">Apache Commons CSV 1.14.0 API</h1>
+</div>
+<div class="block"><img src="../images/commons-logo.png" alt="Apache Commons
CSV">
+ <p>
+ You can find the Javadoc package list at the <a
href="#all-packages-table">bottom of this page</a>.
+ </p>
+ <section>
+ <h1>Introducing Commons CSV</h1>
+ <p>Apache Commons CSV reads and writes files in variations of the Comma
Separated Value (CSV) format.</p>
+ <p>
+ Common CSV formats are predefined in the <a
href="org/apache/commons/csv/CSVFormat.html">CSVFormat</a> class:
+ <table>
+ <caption>CSV Formats</caption>
+ <thead>
+ <tr>
+ <th scope="col">CSVFormat</th>
+ <th scope="col">Description</th>
+ <th scope="col">Since Version</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#DEFAULT">DEFAULT</a></td>
+ <td>IO for the Standard Comma Separated Value format, like <a
href="https://datatracker.ietf.org/doc/html/rfc4180";>RFC 4180</a> but allowing
+ empty lines.
+ </td>
+ <td>1.0</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#EXCEL">EXCEL</a></td>
+ <td>IO for the <a
href="https://support.microsoft.com/en-us/office/import-or-export-text-txt-or-csv-files-5250ac4c-663c-47ce-937b-339e391393ba";>Microsoft
+ Excel CSV.</a> format.
+ </td>
+ <td>1.0</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD">INFORMIX_UNLOAD</a></td>
+ <td>IO for the <a
href="https://www.ibm.com/docs/en/informix-servers/14.10?topic=statements-unload-statement";>Informix
UNLOAD TO file_name</a>
+ command.
+ </td>
+ <td>1.3</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD_CSV">INFORMIX_UNLOAD_CSV</a></td>
+ <td>IO for the <a
href="https://www.ibm.com/docs/en/informix-servers/14.10?topic=statements-unload-statement";>Informix
UNLOAD CSV TO
+ file_name</a> command with escaping disabled.
+ </td>
+ <td>1.3</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#MONGODB_CSV">MONGODB_CSV</a></td>
+ <td>IO for the <a
href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB
CSV <code>mongoexport</code></a> command.
+ </td>
+ <td>1.7</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#MONGODB_TSV">MONGODB_TSV</a></td>
+ <td>IO for the <a
href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB
Tab Separated Values (TSV)<code>mongoexport</code></a>
+ command.
+ </td>
+ <td>1.7</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#MYSQL">MYSQL</a></td>
+ <td>IO for the <a
href="https://dev.mysql.com/doc/refman/8.0/en/mysqldump-delimited-text.html";>MySQL
CSV</a> format.
+ </td>
+ <td>1.0</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#ORACLE">ORACLE</a></td>
+ <td>IO for the <a
href="https://docs.oracle.com/database/121/SUTIL/GUID-D1762699-8154-40F6-90DE-EFB8EB6A9AB0.htm#SUTIL4217";>Oracle
CSV</a> format
+ of the SQL*Loader utility.
+ </td>
+ <td>1.6</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#POSTGRESQL_CSV">POSTGRESQL_CSV</a></td>
+ <td>IO for the <a
href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL
CSV</a> format used by the <code>COPY</code>
+ operation.
+ </td>
+ <td>1.5</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#POSTGRESQL_TEXT">POSTGRESQL_TEXT</a></td>
+ <td>IO for the <a
href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL
Text</a> format used by the <code>COPY</code>
+ operation.
+ </td>
+ <td>1.5</td>
+ </tr>
+ <tr>
+ <td><a
href="org/apache/commons/csv/CSVFormat.html#RFC4180">RFC4180</a></td>
+ <td>IO for the RFC-4180 format defined by<a
href="https://datatracker.ietf.org/doc/html/rfc4180";>RFC 4180</a>.
+ </td>
+ <td>1.0</td>
+ </tr>
+ <tr>
+ <td><a href="org/apache/commons/csv/CSVFormat.html#TDF">TDF</a></td>
+ <td>IO for the <a
href="https://en.wikipedia.org/wiki/Tab-separated_values";>Tab Delimited
Format</a> (also known as Tab Separated Values).
+ </td>
+ <td>1.0</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>Custom formats can be created using a fluent style API.</p>
+ </section>
+ <section>
+ <h1>Parsing Standard CSV Files</h1>
+ <p>
+ Parsing files with Apache Commons CSV is relatively straight forward.
Pick a
+ <code>CSVFormat</code>
+ and go from there.
+ </p>
+ <section>
+ <h2>Parsing an Excel CSV File</h2>
+ <p>To parse an Excel CSV file, write:</p>
+ <pre>
+ <code>
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.EXCEL.parse(in);
+for (CSVRecord record : records) {
+ String lastName = record.get("Last Name");
+ String firstName = record.get("First Name");
+}
+ </code>
+ </pre>
+ </section>
+ </section>
+ <section>
+ <h1>Parsing Custom CSV Files</h1>
+ <p>
+ You can define your own using IO rules by building your own CSVFormat
instance. Starting with
+ <code>CSVFormat.builder()</code>
+ lets you start from a predefined format and customize. For example:
+ </p>
+ <pre>
+ <code>
+CSVFormat myFormat = CSVFormat.DEFAULT.builder()
+ .setCommentMarker('#')
+ .setEscape('+')
+ .setIgnoreSurroundingSpaces(true)
+ .setQuote('"')
+ .setQuoteMode(QuoteMode.ALL)
+ .get()
+ </code>
+ </pre>
+ </section>
+ <section>
+ <h1>Handling Byte Order Marks</h1>
+ <p>
+ To handle files that start with a Byte Order Mark (BOM), like some Excel
CSV files, you need an extra step to deal with the optional BOM bytes. Using the
+ <a
href="https://commons.apache.org/proper/commons-io/apidocs/org/apache/commons/io/input/BOMInputStream.html";>
BOMInputStream </a> class from <a
href="https://commons.apache.org/proper/commons-io/";>Apache Commons IO</a>
simplifies this task; for example:
+ </p>
+ <pre>
+ <code>
+try (Reader reader = new InputStreamReader(BOMInputStream.builder()
+ .setPath(path)
+ .get(), "UTF-8");
+ CSVParser parser = CSVFormat.EXCEL.builder()
+ .setHeader()
+ .get()
+ .parse(reader)) {
+ for (CSVRecord record : parser) {
+ String string = record.get("ColumnA");
+ // ...
+ }
+}
+ </code>
+ </pre>
+ <p>You might find it handy to create something like this:</p>
+ <pre>
+ <code>
+/**
+ * Creates a reader capable of handling BOMs.
+ *
+ * @param path The path to read.
+ * @return a new InputStreamReader for UTF-8 bytes.
+ * @throws IOException if an I/O error occurs.
+ */
+public InputStreamReader newReader(final Path path) throws IOException {
+ return new InputStreamReader(BOMInputStream.builder()
+ .setPath(path)
+ .get(), StandardCharsets.UTF_8);
+}
+ </code>
+ </pre>
+ </section>
+ <section>
+ <h1>Using Headers</h1>
+ <p>
+ Apache Commons CSV provides several ways to access record values. The
simplest way is to access values by their index in the record. However, columns
in
+ CSV files often have a name, for example: ID, CustomerNo, Birthday, etc.
The CSVFormat class provides an API for specifying these <i>header</i> names and
+ CSVRecord on the other hand has methods to access values by their
corresponding header name.
+ </p>
+ <section>
+ <h2>Accessing column values by index</h2>
+ <p>To access a record value by index, no special configuration of the
CSVFormat is necessary:</p>
+ <pre>
+ <code>
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.parse(in);
+for (CSVRecord record : records) {
+ String columnOne = record.get(0);
+ String columnTwo = record.get(1);
+}
+ </code>
+ </pre>
+ </section>
+ <section>
+ <h2>Defining a header manually</h2>
+ <p>Indices may not be the most intuitive way to access record values.
For this reason it is possible to assign names to each column in the file:</p>
+ <pre>
+ <code>
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+ .setHeader("ID", "CustomerNo", "Name")
+ .build()
+ .parse(in);
+for (CSVRecord record : records) {
+ String id = record.get("ID");
+ String customerNo = record.get("CustomerNo");
+ String name = record.get("Name");
+}
+ </code>
+ </pre>
+ Note that column values can still be accessed using their index.
+ </section>
+ <section>
+ <h2>Using an enum to define a header</h2>
+ <p>Using String values all over the code to reference columns can be
error prone. For this reason, it is possible to define an enum to specify header
+ names. Note that the enum constant names are used to access column
values. This may lead to enums constant names which do not follow the Java
coding
+ standard of defining constants in upper case with underscores:</p>
+ <pre>
+ <code>
+public enum Headers {
+ ID, CustomerNo, Name
+}
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+ .setHeader(Headers.class)
+ .build()
+ .parse(in);
+for (CSVRecord record : records) {
+ String id = record.get(Headers.ID);
+ String customerNo = record.get(Headers.CustomerNo);
+ String name = record.get(Headers.Name);
+}
+ </code>
+ </pre>
+ Again it is possible to access values by their index and by using a
String (for example "CustomerNo").
+ </section>
+ <section>
+ <h2>Header auto detection</h2>
+ <p>Some CSV files define header names in their first record. If
configured, Apache Commons CSV can parse the header names from the first
record:</p>
+ <pre>
+ <code>
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+ .setHeader()
+ .setSkipHeaderRecord(true)
+ .build()
+ .parse(in);
+for (CSVRecord record : records) {
+ String id = record.get("ID");
+ String customerNo = record.get("CustomerNo");
+ String name = record.get("Name");
+}
+ </code>
+ </pre>
+ This will use the values from the first record as header names and skip
the first record when iterating.
+ </section>
+ </section>
+ <section>
+ <h1>Printing with headers</h1>
+ <p>To print a CSV file with headers, you specify the headers in the
format:</p>
+ <pre>
+ <code>
+Appendable out = ...;
+CSVPrinter printer = CSVFormat.DEFAULT.builder()
+ .setHeader("H1", "H2")
+ .build()
+ .print(out);
+ </code>
+ </pre>
+ <p>To print a CSV file with JDBC column labels, you specify the ResultSet
in the format:</p>
+ <pre>
+ <code>
+try (ResultSet resultSet = ...) {
+ CSVPrinter printer = CSVFormat.DEFAULT.builder()
+ .setHeader(resultSet)
+ .build()
+ .print(out);
+}
+ </code>
+ </pre>
+ </section>
+ <section>
+ <h1>Working with JDBC</h1>
+ <section>
+ <h2>Exporting JDBC Result Sets</h2>
+ <p>
+ To export row data from a JDBC
+ <code>ResultSet</code>
+ , use <a
href="org/apache/commons/csv/CSVPrinter.html#printRecords(java.sql.ResultSet)">CSVPrinter.printRecords(ResultSet)</a>
:
+ </p>
+ <pre>
+ <code>
+ final StringWriter sw = new StringWriter();
+ final CSVFormat csvFormat = CSVFormat.DEFAULT;
+ try (Connection connection =
DriverManager.getConnection("jdbc:h2:mem:my_test;", "sa", "")) {
+ try (Statement stmt = connection.createStatement();
+ CSVPrinter printer = new CSVPrinter(sw, csvFormat);
+ ResultSet resultSet = stmt.executeQuery("select ID, NAME,
TEXT, BIN_DATA from TEST")) {
+ printer.printRecords(resultSet);
+ }
+ }
+ final String csv = sw.toString();
+ System.out.println(csv);
+ </code>
+ </pre>
+ </section>
+ <section>
+ <h2>Limiting rows from JDBC Result Sets</h2>
+ <p>SQL lets you limit how many rows a SELECT statement returns with the
LIMIT clause.</p>
+ <p>
+ When you can't or don't want to change the SQL used to generate rows,
JDBC lets you limit how many rows a JDBC Statement returns with the <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/Statement.html#setMaxRows(int)">Statement.setMaxRows(int)</a>
method.
+ </p>
+ <p>
+ When you get a JDBC ResultSet from an API like <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/DatabaseMetaData.html#getProcedures(java.lang.String,java.lang.String,java.lang.String)">
+ DatabaseMetaData.getProcedures(...)</a>, there is no SQL or JDBC
Statement to use to set a limit, the ResultSet class does not have an API to
limit rows.
+ </p>
+ <p>
+ To simplify limiting ResultSet rows, Commons CVS offers the <a
href="org/apache/commons/csv/CSVFormat.Builder.html#setMaxRows(long)">CSVFormat.Builder.setMaxRows(long)</a>
+ method. For example:
+ </p>
+ <pre>
+ <code>
+ CSVFormat csvFormat = CSVFormat.DEFAULT
+ .setMaxRows(5_000)
+ .get();
+ try (ResultSet resultSet = ...) {
+ csvFormat.printer().printRecords(resultSet);
+ }
+ </code>
+ </pre>
+ <p>
+ Using the above, calling <a
href="org/apache/commons/csv/CSVPrinter.html#printRecords(java.sql.ResultSet)">CSVPrinter.printRecords(ResultSet)</a>
will
+ limit the row count to the maximum number of rows specified in
setMaxRows().
+ </p>
+ <p>Note that setMaxRows() works with the other methods that print a
sequence of records.</p>
+ </section>
+ </section></div>
+<div id="all-packages-table">
+<div class="caption"><span>Packages</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color all-packages-table
all-packages-table-tab1"><a
href="org/apache/commons/csv/package-summary.html">org.apache.commons.csv</a></div>
+<div class="col-last even-row-color all-packages-table
all-packages-table-tab1">
+<div class="block">Apache Commons CSV</div>
+</div>
+</div>
+</div>
</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>
+</div>
</body>
</html>
\ No newline at end of file
Added:
websites/production/commons/content/proper/commons-csv/apidocs/jquery-ui.overrides.css
==============================================================================
---
websites/production/commons/content/proper/commons-csv/apidocs/jquery-ui.overrides.css
(added)
+++
websites/production/commons/content/proper/commons-csv/apidocs/jquery-ui.overrides.css
Wed Mar 19 22:20:06 2025
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+.ui-state-active,
+.ui-widget-content .ui-state-active,
+.ui-widget-header .ui-state-active,
+a.ui-button:active,
+.ui-button:active,
+.ui-button.ui-state-active:hover {
+ /* Overrides the color of selection used in jQuery UI */
+ background: #F8981D;
+ border: 1px solid #F8981D;
+}
\ No newline at end of file
Modified:
websites/production/commons/content/proper/commons-csv/apidocs/legal/ASSEMBLY_EXCEPTION
==============================================================================
---
websites/production/commons/content/proper/commons-csv/apidocs/legal/ASSEMBLY_EXCEPTION
(original)
+++
websites/production/commons/content/proper/commons-csv/apidocs/legal/ASSEMBLY_EXCEPTION
Wed Mar 19 22:20:06 2025
@@ -2,8 +2,8 @@
OPENJDK ASSEMBLY EXCEPTION
The OpenJDK source code made available by Oracle America, Inc. (Oracle) at
-openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU
-General Public License <https://www.gnu.org/copyleft/gpl.html> version 2
+openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU
+General Public License <http://www.gnu.org/copyleft/gpl.html> version 2
only ("GPL2"), with the following clarification and special exception.
Linking this OpenJDK Code statically or dynamically with other code
@@ -12,7 +12,7 @@ only ("GPL2"), with the following clarif
As a special exception, Oracle gives you permission to link this
OpenJDK Code with certain code licensed by Oracle as indicated at
- https://openjdk.org/legal/exception-modules-2007-05-08.html
+ http://openjdk.java.net/legal/exception-modules-2007-05-08.html
("Designated Exception Modules") to produce an executable,
regardless of the license terms of the Designated Exception Modules,
and to copy and distribute the resulting executable under GPL2,
