Added: dev/commons/csv/1.8-RC2/site/apidocs/org/apache/commons/csv/CSVFormat.html ============================================================================== --- dev/commons/csv/1.8-RC2/site/apidocs/org/apache/commons/csv/CSVFormat.html (added) +++ dev/commons/csv/1.8-RC2/site/apidocs/org/apache/commons/csv/CSVFormat.html Sun Feb 2 01:23:05 2020 @@ -0,0 +1,2628 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CSVFormat (Apache Commons CSV 1.8 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CSVFormat (Apache Commons CSV 1.8 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":9,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":9,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../org/apache/commons/csv/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CSVFormat.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/csv/CSVFormat.html" target="_top">Frames</a></li> +<li><a href="CSVFormat.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><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="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.csv</div> +<h2 title="Class CSVFormat" class="title">Class CSVFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.csv.CSVFormat</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">CSVFormat</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></pre> +<div class="block">Specifies the format of a CSV file and parses input. + + <h2>Using predefined formats</h2> + + <p> + You can use one of the predefined formats: + </p> + + <ul> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT"><code>DEFAULT</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL"><code>EXCEL</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD"><code>INFORMIX_UNLOAD</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD_CSV"><code>INFORMIX_UNLOAD_CSV</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL"><code>MYSQL</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#ORACLE"><code>ORACLE</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#POSTGRESQL_CSV"><code>POSTGRESQL_CSV</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#POSTGRESQL_TEXT"><code>POSTGRESQL_TEXT</code></a></li> + <li><a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF"><code>TDF</code></a></li> + </ul> + + <p> + For example: + </p> + + <pre> + CSVParser parser = CSVFormat.EXCEL.parse(reader); + </pre> + + <p> + The <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a> provides static methods to parse other input types, for example: + </p> + + <pre> + CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL); + </pre> + + <h2>Defining formats</h2> + + <p> + You can extend a format by calling the <code>with</code> methods. For example: + </p> + + <pre> + CSVFormat.EXCEL.withNullString("N/A").withIgnoreSurroundingSpaces(true); + </pre> + + <h2>Defining column names</h2> + + <p> + To define the column names you want to use to access records, write: + </p> + + <pre> + CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3"); + </pre> + + <p> + Calling <a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.String...-"><code>withHeader(String...)</code></a> let's you use the given names to address values in a <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecord</code></a>, and + assumes that your CSV source does not contain a first record that also defines column names. + + If it does, then you are overriding this metadata with your names and you should skip the first record by calling + <a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord-boolean-"><code>withSkipHeaderRecord(boolean)</code></a> with <code>true</code>. + </p> + + <h2>Parsing</h2> + + <p> + You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write: + </p> + + <pre> + Reader in = ...; + CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3").parse(in); + </pre> + + <p> + For other input types, like resources, files, and URLs, use the static methods on <a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><code>CSVParser</code></a>. + </p> + + <h2>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="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.String...-"><code>withHeader(String...)</code></a> with no arguments: + </p> + + <pre> + CSVFormat.EXCEL.withHeader(); + </pre> + + <p> + This causes the parser to read the first record and use its values as column names. + + Then, call one of the <a href="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><code>CSVRecord</code></a> get method that takes a String column name argument: + </p> + + <pre> + String value = record.get("Col1"); + </pre> + + <p> + This makes your code impervious to changes in column order in the CSV file. + </p> + + <h2>Notes</h2> + + <p> + This class is immutable. + </p></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv">CSVFormat.Predefined</a></span></code> +<div class="block">Predefines formats.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT">DEFAULT</a></span></code> +<div class="block">Standard Comma Separated Value format, as for <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> but allowing empty lines.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL">EXCEL</a></span></code> +<div class="block">Excel file format (using a comma as the value delimiter).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD">INFORMIX_UNLOAD</a></span></code> +<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#INFORMIX_UNLOAD_CSV">INFORMIX_UNLOAD_CSV</a></span></code> +<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation (escaping is disabled.)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#MONGODB_CSV">MONGODB_CSV</a></span></code> +<div class="block">Default MongoDB CSV format used by the <code>mongoexport</code> operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#MONGODB_TSV">MONGODB_TSV</a></span></code> +<div class="block">Default MongoDB TSV format used by the <code>mongoexport</code> operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL">MYSQL</a></span></code> +<div class="block">Default MySQL format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA INFILE</code> operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#ORACLE">ORACLE</a></span></code> +<div class="block">Default Oracle format used by the SQL*Loader utility.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#POSTGRESQL_CSV">POSTGRESQL_CSV</a></span></code> +<div class="block">Default PostgreSQL CSV format used by the <code>COPY</code> operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#POSTGRESQL_TEXT">POSTGRESQL_TEXT</a></span></code> +<div class="block">Default PostgreSQL text format used by the <code>COPY</code> operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180">RFC4180</a></span></code> +<div class="block">Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF">TDF</a></span></code> +<div class="block">Tab-delimited format.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#format-java.lang.Object...-">format</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</code> +<div class="block">Formats the specified values.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getAllowDuplicateHeaderNames--">getAllowDuplicateHeaderNames</a></span>()</code> +<div class="block">Returns true if and only if duplicate names are allowed in the headers.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getAllowMissingColumnNames--">getAllowMissingColumnNames</a></span>()</code> +<div class="block">Specifies whether missing column names are allowed when parsing the header line.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getAutoFlush--">getAutoFlush</a></span>()</code> +<div class="block">Returns whether to flush on close.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getCommentMarker--">getCommentMarker</a></span>()</code> +<div class="block">Returns the character marking the start of a line comment.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getDelimiter--">getDelimiter</a></span>()</code> +<div class="block">Returns the character delimiting the values (typically ';', ',' or '\t').</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getEscapeCharacter--">getEscapeCharacter</a></span>()</code> +<div class="block">Returns the escape character.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getHeader--">getHeader</a></span>()</code> +<div class="block">Returns a copy of the header array.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getHeaderComments--">getHeaderComments</a></span>()</code> +<div class="block">Returns a copy of the header comment array.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreEmptyLines--">getIgnoreEmptyLines</a></span>()</code> +<div class="block">Specifies whether empty lines between records are ignored when parsing input.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreHeaderCase--">getIgnoreHeaderCase</a></span>()</code> +<div class="block">Specifies whether header names will be accessed ignoring case.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreSurroundingSpaces--">getIgnoreSurroundingSpaces</a></span>()</code> +<div class="block">Specifies whether spaces around values are ignored when parsing input.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getNullString--">getNullString</a></span>()</code> +<div class="block">Gets the String to convert to and from <code>null</code>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteCharacter--">getQuoteCharacter</a></span>()</code> +<div class="block">Returns the character used to encapsulate values containing special characters.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteMode--">getQuoteMode</a></span>()</code> +<div class="block">Returns the quote policy output fields.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getRecordSeparator--">getRecordSeparator</a></span>()</code> +<div class="block">Returns the record separator delimiting output records.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getSkipHeaderRecord--">getSkipHeaderRecord</a></span>()</code> +<div class="block">Returns whether to skip the header record.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getTrailingDelimiter--">getTrailingDelimiter</a></span>()</code> +<div class="block">Returns whether to add a trailing delimiter.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#getTrim--">getTrim</a></span>()</code> +<div class="block">Returns whether to trim leading and trailing blanks.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#isCommentMarkerSet--">isCommentMarkerSet</a></span>()</code> +<div class="block">Specifies whether comments are supported by this format.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#isEscapeCharacterSet--">isEscapeCharacterSet</a></span>()</code> +<div class="block">Returns whether escape are being processed.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#isNullStringSet--">isNullStringSet</a></span>()</code> +<div class="block">Returns whether a nullString has been defined.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#isQuoteCharacterSet--">isQuoteCharacterSet</a></span>()</code> +<div class="block">Returns whether a quoteChar has been defined.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#newFormat-char-">newFormat</a></span>(char delimiter)</code> +<div class="block">Creates a new CSV format with the specified delimiter.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv">CSVParser</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#parse-java.io.Reader-">parse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> in)</code> +<div class="block">Parses the specified content.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.lang.Appendable-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> out)</code> +<div class="block">Prints to the specified output.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.io.File-java.nio.charset.Charset-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> out, + <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"; title="class or interface in java.nio.charset">Charset</a> charset)</code> +<div class="block">Prints to the specified output.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.lang.Object-java.lang.Appendable-boolean-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> out, + boolean newRecord)</code> +<div class="block">Prints the <code>value</code> as the next value on the line to <code>out</code>.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.nio.file.Path-java.nio.charset.Charset-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true"; title="class or interface in java.nio.file">Path</a> out, + <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true"; title="class or interface in java.nio.charset">Charset</a> charset)</code> +<div class="block">Prints to the specified output.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#printer--">printer</a></span>()</code> +<div class="block">Prints to the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#out"; title="class or interface in java.lang"><code>System.out</code></a>.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#println-java.lang.Appendable-">println</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> out)</code> +<div class="block">Outputs the trailing delimiter (if set) followed by the record separator (if set).</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#printRecord-java.lang.Appendable-java.lang.Object...-">printRecord</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> out, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</code> +<div class="block">Prints the given <code>values</code> to <code>out</code> as a single record of delimiter separated values followed by the + record separator.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> format)</code> +<div class="block">Gets one of the predefined formats from <a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><code>CSVFormat.Predefined</code></a>.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowDuplicateHeaderNames--">withAllowDuplicateHeaderNames</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> that allows duplicate header names.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowDuplicateHeaderNames-boolean-">withAllowDuplicateHeaderNames</a></span>(boolean allowDuplicateHeaderNames)</code> +<div class="block">Returns a new <code>CSVFormat</code> with duplicate header names behavior set to the given value.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames--">withAllowMissingColumnNames</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with the missing column names behavior of the format set to <code>true</code></div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames-boolean-">withAllowMissingColumnNames</a></span>(boolean allowMissingColumnNames)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the missing column names behavior of the format set to the given value.</div> +</td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withAutoFlush-boolean-">withAutoFlush</a></span>(boolean autoFlush)</code> +<div class="block">Returns a new <code>CSVFormat</code> with whether to flush on close.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker-char-">withCommentMarker</a></span>(char commentMarker)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the comment start marker of the format set to the specified character.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withCommentMarker-java.lang.Character-">withCommentMarker</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> commentMarker)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the comment start marker of the format set to the specified character.</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withDelimiter-char-">withDelimiter</a></span>(char delimiter)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the delimiter of the format set to the specified character.</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape-char-">withEscape</a></span>(char escape)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the escape character of the format set to the specified character.</div> +</td> +</tr> +<tr id="i45" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withEscape-java.lang.Character-">withEscape</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> escape)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the escape character of the format set to the specified character.</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withFirstRecordAsHeader--">withFirstRecordAsHeader</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> using the first record as header.</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.Class-">withHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><?>> headerEnum)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header of the format defined by the enum class.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.sql.ResultSet-">withHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true"; title="class or interface in java.sql">ResultSet</a> resultSet)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header of the format set from the result set metadata.</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.sql.ResultSetMetaData-">withHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true"; title="class or interface in java.sql">ResultSetMetaData</a> metaData)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header of the format set from the result set metadata.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeader-java.lang.String...-">withHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... header)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header of the format set to the given values.</div> +</td> +</tr> +<tr id="i51" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withHeaderComments-java.lang.Object...-">withHeaderComments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... headerComments)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header comments of the format set to the given values.</div> +</td> +</tr> +<tr id="i52" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines--">withIgnoreEmptyLines</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with the empty line skipping behavior of the format set to <code>true</code>.</div> +</td> +</tr> +<tr id="i53" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines-boolean-">withIgnoreEmptyLines</a></span>(boolean ignoreEmptyLines)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the empty line skipping behavior of the format set to the given value.</div> +</td> +</tr> +<tr id="i54" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreHeaderCase--">withIgnoreHeaderCase</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with the header ignore case behavior set to <code>true</code>.</div> +</td> +</tr> +<tr id="i55" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreHeaderCase-boolean-">withIgnoreHeaderCase</a></span>(boolean ignoreHeaderCase)</code> +<div class="block">Returns a new <code>CSVFormat</code> with whether header names should be accessed ignoring case.</div> +</td> +</tr> +<tr id="i56" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces--">withIgnoreSurroundingSpaces</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with the parser trimming behavior of the format set to <code>true</code>.</div> +</td> +</tr> +<tr id="i57" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreSurroundingSpaces-boolean-">withIgnoreSurroundingSpaces</a></span>(boolean ignoreSurroundingSpaces)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the parser trimming behavior of the format set to the given value.</div> +</td> +</tr> +<tr id="i58" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withNullString-java.lang.String-">withNullString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> nullString)</code> +<div class="block">Returns a new <code>CSVFormat</code> with conversions to and from null for strings on input and output.</div> +</td> +</tr> +<tr id="i59" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote-char-">withQuote</a></span>(char quoteChar)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the quoteChar of the format set to the specified character.</div> +</td> +</tr> +<tr id="i60" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuote-java.lang.Character-">withQuote</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> quoteChar)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the quoteChar of the format set to the specified character.</div> +</td> +</tr> +<tr id="i61" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withQuoteMode-org.apache.commons.csv.QuoteMode-">withQuoteMode</a></span>(<a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a> quoteModePolicy)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the output quote policy of the format set to the specified value.</div> +</td> +</tr> +<tr id="i62" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator-char-">withRecordSeparator</a></span>(char recordSeparator)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the record separator of the format set to the specified character.</div> +</td> +</tr> +<tr id="i63" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withRecordSeparator-java.lang.String-">withRecordSeparator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> recordSeparator)</code> +<div class="block">Returns a new <code>CSVFormat</code> with the record separator of the format set to the specified String.</div> +</td> +</tr> +<tr id="i64" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord--">withSkipHeaderRecord</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with skipping the header record set to <code>true</code>.</div> +</td> +</tr> +<tr id="i65" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSkipHeaderRecord-boolean-">withSkipHeaderRecord</a></span>(boolean skipHeaderRecord)</code> +<div class="block">Returns a new <code>CSVFormat</code> with whether to skip the header record.</div> +</td> +</tr> +<tr id="i66" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withSystemRecordSeparator--">withSystemRecordSeparator</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> with the record separator of the format set to the operating system's line + separator string, typically CR+LF on Windows and LF on Linux.</div> +</td> +</tr> +<tr id="i67" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withTrailingDelimiter--">withTrailingDelimiter</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> to add a trailing delimiter.</div> +</td> +</tr> +<tr id="i68" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withTrailingDelimiter-boolean-">withTrailingDelimiter</a></span>(boolean trailingDelimiter)</code> +<div class="block">Returns a new <code>CSVFormat</code> with whether to add a trailing delimiter.</div> +</td> +</tr> +<tr id="i69" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withTrim--">withTrim</a></span>()</code> +<div class="block">Returns a new <code>CSVFormat</code> to trim leading and trailing blanks.</div> +</td> +</tr> +<tr id="i70" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/csv/CSVFormat.html#withTrim-boolean-">withTrim</a></span>(boolean trim)</code> +<div class="block">Returns a new <code>CSVFormat</code> with whether to trim leading and trailing blanks.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.htm l?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> DEFAULT</pre> +<div class="block">Standard Comma Separated Value format, as for <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> but allowing empty lines. + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withRecordSeparator("\r\n")</code></li> + <li><code>withIgnoreEmptyLines(true)</code></li> + <li><code>withAllowDuplicateHeaderNames(true)</code></li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#Default"><code>CSVFormat.Predefined.Default</code></a></dd> +</dl> +</li> +</ul> +<a name="EXCEL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXCEL</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> EXCEL</pre> +<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 to your regional settings. + + <p> + For example for parsing or generating a CSV file on a French system the following format will be used: + </p> + + <pre> + CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';'); + </pre> + + <p> + Settings are: + </p> + <ul> + <li><code>{@link #withDelimiter(char) withDelimiter(',')}</code></li> + <li><code>{@link #withQuote(char) withQuote('"')}</code></li> + <li><code>{@link #withRecordSeparator(String) withRecordSeparator("\r\n")}</code></li> + <li><code>{@link #withIgnoreEmptyLines(boolean) withIgnoreEmptyLines(false)}</code></li> + <li><code>{@link #withAllowMissingColumnNames(boolean) withAllowMissingColumnNames(true)}</code></li> + <li><code>{@link #withAllowDuplicateHeaderNames(boolean) withAllowDuplicateHeaderNames(true)}</code></li> + </ul> + <p> + Note: This is currently like <a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a> plus <a href="../../../../org/apache/commons/csv/CSVFormat.html#withAllowMissingColumnNames-boolean-"><code>withAllowMissingColumnNames(true)</code></a> and <a href="../../../../org/apache/commons/csv/CSVFormat.html#withIgnoreEmptyLines-boolean-"><code>withIgnoreEmptyLines(false)</code></a>. + </p></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#Excel"><code>CSVFormat.Predefined.Excel</code></a></dd> +</dl> +</li> +</ul> +<a name="INFORMIX_UNLOAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INFORMIX_UNLOAD</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> INFORMIX_UNLOAD</pre> +<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation. + + <p> + This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special + characters are escaped with <code>'\'</code>. The default NULL string is <code>"\\N"</code>. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withEscape('\\')</code></li> + <li><code>withQuote("\"")</code></li> + <li><code>withRecordSeparator('\n')</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.3</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>, +<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></dd> +</dl> +</li> +</ul> +<a name="INFORMIX_UNLOAD_CSV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INFORMIX_UNLOAD_CSV</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> INFORMIX_UNLOAD_CSV</pre> +<div class="block">Default Informix CSV UNLOAD format used by the <code>UNLOAD TO file_name</code> operation (escaping is disabled.) + + <p> + This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special + characters are escaped with <code>'\'</code>. The default NULL string is <code>"\\N"</code>. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withQuote("\"")</code></li> + <li><code>withRecordSeparator('\n')</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.3</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>, +<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></dd> +</dl> +</li> +</ul> +<a name="MONGODB_CSV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MONGODB_CSV</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> MONGODB_CSV</pre> +<div class="block">Default MongoDB CSV format used by the <code>mongoexport</code> operation. + <p> + <b>Parsing is not supported yet.</b> + </p> + + <p> + This is a comma-delimited format. Values are double quoted only if needed and special characters are escaped with + <code>'"'</code>. A header line with field names is expected. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withEscape('"')</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><code>withSkipHeaderRecord(false)</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MongoDBCsv"><code>CSVFormat.Predefined.MongoDBCsv</code></a>, +<a href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB mongoexport command + documentation</a></dd> +</dl> +</li> +</ul> +<a name="MONGODB_TSV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MONGODB_TSV</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> MONGODB_TSV</pre> +<div class="block">Default MongoDB TSV format used by the <code>mongoexport</code> operation. + <p> + <b>Parsing is not supported yet.</b> + </p> + + <p> + This is a tab-delimited format. Values are double quoted only if needed and special + characters are escaped with <code>'"'</code>. A header line with field names is expected. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter('\t')</code></li> + <li><code>withEscape('"')</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + <li><code>withSkipHeaderRecord(false)</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MongoDBCsv"><code>CSVFormat.Predefined.MongoDBCsv</code></a>, +<a href="https://docs.mongodb.com/manual/reference/program/mongoexport/";>MongoDB mongoexport command + documentation</a></dd> +</dl> +</li> +</ul> +<a name="MYSQL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MYSQL</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> MYSQL</pre> +<div class="block">Default MySQL format used by the <code>SELECT INTO OUTFILE</code> and <code>LOAD DATA INFILE</code> operations. + + <p> + This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special + characters are escaped with <code>'\'</code>. The default NULL string is <code>"\\N"</code>. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter('\t')</code></li> + <li><code>withEscape('\\')</code></li> + <li><code>withIgnoreEmptyLines(false)</code></li> + <li><code>withQuote(null)</code></li> + <li><code>withRecordSeparator('\n')</code></li> + <li><code>withNullString("\\N")</code></li> + <li><code>withQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>, +<a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html";> http://dev.mysql.com/doc/refman/5.1/en/load + -data.html</a></dd> +</dl> +</li> +</ul> +<a name="ORACLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ORACLE</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> ORACLE</pre> +<div class="block">Default Oracle format used by the SQL*Loader utility. + + <p> + This is a comma-delimited format with the system line separator character as the record separator.Values are + double quoted when needed and special characters are escaped with <code>'"'</code>. The default NULL string is + <code>""</code>. Values are trimmed. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',') // default is {@code FIELDS TERMINATED BY ','}</code></li> + <li><code>withEscape('\\')</code></li> + <li><code>withIgnoreEmptyLines(false)</code></li> + <li><code>withQuote('"') // default is {@code OPTIONALLY ENCLOSED BY '"'}</code></li> + <li><code>withNullString("\\N")</code></li> + <li><code>withTrim()</code></li> + <li><code>withSystemRecordSeparator()</code></li> + <li><code>withQuoteMode(QuoteMode.MINIMAL)</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#Oracle"><code>CSVFormat.Predefined.Oracle</code></a>, +<a href="https://s.apache.org/CGXG";>Oracle CSV Format Specification</a></dd> +</dl> +</li> +</ul> +<a name="POSTGRESQL_CSV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>POSTGRESQL_CSV</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> POSTGRESQL_CSV</pre> +<div class="block">Default PostgreSQL CSV format used by the <code>COPY</code> operation. + + <p> + This is a comma-delimited format with a LF character as the line separator. Values are double quoted and special + characters are escaped with <code>'"'</code>. The default NULL string is <code>""</code>. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withEscape('"')</code></li> + <li><code>withIgnoreEmptyLines(false)</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withRecordSeparator('\n')</code></li> + <li><code>withNullString("")</code></li> + <li><code>withQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>, +<a href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL COPY command + documentation</a></dd> +</dl> +</li> +</ul> +<a name="POSTGRESQL_TEXT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>POSTGRESQL_TEXT</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> POSTGRESQL_TEXT</pre> +<div class="block">Default PostgreSQL text format used by the <code>COPY</code> operation. + + <p> + This is a tab-delimited format with a LF character as the line separator. Values are double quoted and special + characters are escaped with <code>'"'</code>. The default NULL string is <code>"\\N"</code>. + </p> + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter('\t')</code></li> + <li><code>withEscape('\\')</code></li> + <li><code>withIgnoreEmptyLines(false)</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withRecordSeparator('\n')</code></li> + <li><code>withNullString("\\N")</code></li> + <li><code>withQuoteMode(QuoteMode.ALL_NON_NULL)</code></li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#MySQL"><code>CSVFormat.Predefined.MySQL</code></a>, +<a href="https://www.postgresql.org/docs/current/static/sql-copy.html";>PostgreSQL COPY command + documentation</a></dd> +</dl> +</li> +</ul> +<a name="RFC4180"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RFC4180</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> RFC4180</pre> +<div class="block">Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>. + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter(',')</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withRecordSeparator("\r\n")</code></li> + <li><code>withIgnoreEmptyLines(false)</code></li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#RFC4180"><code>CSVFormat.Predefined.RFC4180</code></a></dd> +</dl> +</li> +</ul> +<a name="TDF"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TDF</h4> +<pre>public static final <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> TDF</pre> +<div class="block">Tab-delimited format. + + <p> + Settings are: + </p> + <ul> + <li><code>withDelimiter('\t')</code></li> + <li><code>withQuote('"')</code></li> + <li><code>withRecordSeparator("\r\n")</code></li> + <li><code>withIgnoreSurroundingSpaces(true)</code></li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html#TDF"><code>CSVFormat.Predefined.TDF</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newFormat-char-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newFormat</h4> +<pre>public static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> newFormat(char delimiter)</pre> +<div class="block">Creates a new CSV format with the specified delimiter. + + <p> + Use this method if you want to create a CSVFormat from scratch. All fields but the delimiter will be initialized + with null/false. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>delimiter</code> - the char used for value separation, must not be a line break character</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new CSV format.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the delimiter is a line break character</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT"><code>DEFAULT</code></a>, +<a href="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><code>RFC4180</code></a>, +<a href="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL"><code>MYSQL</code></a>, +<a href="../../../../org/apache/commons/csv/CSVFormat.html#EXCEL"><code>EXCEL</code></a>, +<a href="../../../../org/apache/commons/csv/CSVFormat.html#TDF"><code>TDF</code></a></dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</a> valueOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> format)</pre> +<div class="block">Gets one of the predefined formats from <a href="../../../../org/apache/commons/csv/CSVFormat.Predefined.html" title="enum in org.apache.commons.csv"><code>CSVFormat.Predefined</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>format</code> - name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>one of the predefined formats</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.2</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="format-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>format</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> format(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</pre> +<div class="block">Formats the specified values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>values</code> - the values to format</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the formatted values</dd> +</dl> +</li> +</ul> +<a name="getAllowDuplicateHeaderNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowDuplicateHeaderNames</h4> +<pre>public boolean getAllowDuplicateHeaderNames()</pre> +<div class="block">Returns true if and only if duplicate names are allowed in the headers.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether duplicate header names are allowed</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.7</dd> +</dl> +</li> +</ul> +<a name="getAllowMissingColumnNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowMissingColumnNames</h4> +<pre>public boolean getAllowMissingColumnNames()</pre> +<div class="block">Specifies whether missing column names are allowed when parsing the header line.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></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/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang"><code>IllegalArgumentException</code></a>.</dd> +</dl> +</li> +</ul> +<a name="getAutoFlush--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoFlush</h4> +<pre>public boolean getAutoFlush()</pre> +<div class="block">Returns whether to flush on close.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether to flush on close.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.6</dd> +</dl> +</li> +</ul> +<a name="getCommentMarker--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCommentMarker</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> getCommentMarker()</pre> +<div class="block">Returns the character marking the start of a line comment.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the comment start marker, may be <code>null</code></dd> +</dl> +</li> +</ul> +<a name="getDelimiter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDelimiter</h4> +<pre>public char getDelimiter()</pre> +<div class="block">Returns the character delimiting the values (typically ';', ',' or '\t').</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the delimiter character</dd> +</dl> +</li> +</ul> +<a name="getEscapeCharacter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEscapeCharacter</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> getEscapeCharacter()</pre> +<div class="block">Returns the escape character.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the escape character, may be <code>null</code></dd> +</dl> +</li> +</ul> +<a name="getHeader--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeader</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] getHeader()</pre> +<div class="block">Returns a copy of the header array.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></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> +</li> +</ul> +<a name="getHeaderComments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeaderComments</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] getHeaderComments()</pre> +<div class="block">Returns a copy of the header comment array.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a copy of the header comment array; <code>null</code> if disabled.</dd> +</dl> +</li> +</ul> +<a name="getIgnoreEmptyLines--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIgnoreEmptyLines</h4> +<pre>public boolean getIgnoreEmptyLines()</pre> +<div class="block">Specifies whether empty lines between records are ignored when parsing input.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if empty lines between records are ignored, <code>false</code> if they are turned into empty + records.</dd> +</dl> +</li> +</ul> +<a name="getIgnoreHeaderCase--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIgnoreHeaderCase</h4> +<pre>public boolean getIgnoreHeaderCase()</pre> +<div class="block">Specifies whether header names will be accessed ignoring case.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if header names cases are ignored, <code>false</code> if they are case sensitive.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.3</dd> +</dl> +</li> +</ul> +<a name="getIgnoreSurroundingSpaces--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIgnoreSurroundingSpaces</h4> +<pre>public boolean getIgnoreSurroundingSpaces()</pre> +<div class="block">Specifies whether spaces around values are ignored when parsing input.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></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> +</li> +</ul> +<a name="getNullString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNullString</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getNullString()</pre> +<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> + <li><strong>Writing:</strong> Writes <code>null</code> as the given <code>nullString</code> when writing records.</li> + </ul></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the String to convert to and from <code>null</code>. No substitution occurs if <code>null</code></dd> +</dl> +</li> +</ul> +<a name="getQuoteCharacter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQuoteCharacter</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true"; title="class or interface in java.lang">Character</a> getQuoteCharacter()</pre> +<div class="block">Returns the character used to encapsulate values containing special characters.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the quoteChar character, may be <code>null</code></dd> +</dl> +</li> +</ul> +<a name="getQuoteMode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQuoteMode</h4> +<pre>public <a href="../../../../org/apache/commons/csv/QuoteMode.html" title="enum in org.apache.commons.csv">QuoteMode</a> getQuoteMode()</pre> +<div class="block">Returns the quote policy output fields.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the quote policy</dd> +</dl> +</li> +</ul> +<a name="getRecordSeparator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordSeparator</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getRecordSeparator()</pre> +<div class="block">Returns the record separator delimiting output records.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the record separator</dd> +</dl> +</li> +</ul> +<a name="getSkipHeaderRecord--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkipHeaderRecord</h4> +<pre>public boolean getSkipHeaderRecord()</pre> +<div class="block">Returns whether to skip the header record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether to skip the header record.</dd> +</dl> +</li> +</ul> +<a name="getTrailingDelimiter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTrailingDelimiter</h4> +<pre>public boolean getTrailingDelimiter()</pre> +<div class="block">Returns whether to add a trailing delimiter.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether to add a trailing delimiter.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.3</dd> +</dl> +</li> +</ul> +<a name="getTrim--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTrim</h4> +<pre>public boolean getTrim()</pre> +<div class="block">Returns whether to trim leading and trailing blanks. + This is used by <a href="../../../../org/apache/commons/csv/CSVFormat.html#print-java.lang.Object-java.lang.Appendable-boolean-"><code>print(Object, Appendable, boolean)</code></a> + Also by <a href="../../../../org/apache/commons/csv/CSVParser.html#addRecordValue-boolean-"><code>CSVParser.addRecordValue(boolean)</code></a></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether to trim leading and trailing blanks.</dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="isCommentMarkerSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCommentMarkerSet</h4> +<pre>public boolean isCommentMarkerSet()</pre> +<div class="block">Specifies whether comments are supported by this format. + + Note that the comment introducer character is only recognized at the start of a line.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> is comments are supported, <code>false</code> otherwise</dd> +</dl> +</li> +</ul> +<a name="isEscapeCharacterSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEscapeCharacterSet</h4> +<pre>public boolean isEscapeCharacterSet()</pre> +<div class="block">Returns whether escape are being processed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if escapes are processed</dd> +</dl> +</li> +</ul> +<a name="isNullStringSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullStringSet</h4> +<pre>public boolean isNullStringSet()</pre> +<div class="block">Returns whether a nullString has been defined.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if a nullString is defined</dd> +</dl> +</li> +</ul> +<a name="isQuoteCharacterSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isQuoteCharacterSet</h4> +<pre>public boolean isQuoteCharacterSet()</pre> +<div class="block">Returns whether a quoteChar has been defined.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if a quoteChar is defined</dd>
[... 1007 lines stripped ...]
