commons-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r989467 [8/43] - in /websites/production/commons/content/proper/commons-csv/archives/1.4: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/commons/ apidocs/org/apache/commons/csv/ apidocs/org/apache/commons/csv/class-use/ api...
Date Sun, 29 May 2016 02:48:45 GMT
Added: websites/production/commons/content/proper/commons-csv/archives/1.4/apidocs/src-html/org/apache/commons/csv/CSVFormat.Predefined.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/archives/1.4/apidocs/src-html/org/apache/commons/csv/CSVFormat.Predefined.html (added)
+++ websites/production/commons/content/proper/commons-csv/archives/1.4/apidocs/src-html/org/apache/commons/csv/CSVFormat.Predefined.html Sun May 29 02:48:43 2016
@@ -0,0 +1,1839 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span><a name="line.17"></a>
+<span class="sourceLineNo">018</span>package org.apache.commons.csv;<a name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span>import static org.apache.commons.csv.Constants.BACKSLASH;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import static org.apache.commons.csv.Constants.COMMA;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import static org.apache.commons.csv.Constants.COMMENT;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import static org.apache.commons.csv.Constants.CR;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import static org.apache.commons.csv.Constants.CRLF;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import static org.apache.commons.csv.Constants.DOUBLE_QUOTE_CHAR;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import static org.apache.commons.csv.Constants.LF;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import static org.apache.commons.csv.Constants.PIPE;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import static org.apache.commons.csv.Constants.SP;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import static org.apache.commons.csv.Constants.TAB;<a name="line.29"></a>
+<span class="sourceLineNo">030</span><a name="line.30"></a>
+<span class="sourceLineNo">031</span>import java.io.IOException;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import java.io.Reader;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import java.io.Serializable;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import java.io.StringWriter;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import java.sql.ResultSet;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import java.sql.ResultSetMetaData;<a name="line.36"></a>
+<span class="sourceLineNo">037</span>import java.sql.SQLException;<a name="line.37"></a>
+<span class="sourceLineNo">038</span>import java.util.Arrays;<a name="line.38"></a>
+<span class="sourceLineNo">039</span>import java.util.HashSet;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>import java.util.Set;<a name="line.40"></a>
+<span class="sourceLineNo">041</span><a name="line.41"></a>
+<span class="sourceLineNo">042</span>/**<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * Specifies the format of a CSV file and parses input.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * &lt;h2&gt;Using predefined formats&lt;/h2&gt;<a name="line.45"></a>
+<span class="sourceLineNo">046</span> *<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * &lt;p&gt;<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * You can use one of the predefined formats:<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * &lt;/p&gt;<a name="line.49"></a>
+<span class="sourceLineNo">050</span> *<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * &lt;ul&gt;<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * &lt;li&gt;{@link #DEFAULT}&lt;/li&gt;<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * &lt;li&gt;{@link #EXCEL}&lt;/li&gt;<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * &lt;li&gt;{@link #MYSQL}&lt;/li&gt;<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * &lt;li&gt;{@link #RFC4180}&lt;/li&gt;<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * &lt;li&gt;{@link #TDF}&lt;/li&gt;<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * &lt;/ul&gt;<a name="line.57"></a>
+<span class="sourceLineNo">058</span> *<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * &lt;p&gt;<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * For example:<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * &lt;/p&gt;<a name="line.61"></a>
+<span class="sourceLineNo">062</span> *<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * &lt;pre&gt;<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * CSVParser parser = CSVFormat.EXCEL.parse(reader);<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * &lt;/pre&gt;<a name="line.65"></a>
+<span class="sourceLineNo">066</span> *<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * &lt;p&gt;<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * The {@link CSVParser} provides static methods to parse other input types, for example:<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * &lt;/p&gt;<a name="line.69"></a>
+<span class="sourceLineNo">070</span> *<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * &lt;pre&gt;<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL);<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * &lt;/pre&gt;<a name="line.73"></a>
+<span class="sourceLineNo">074</span> *<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * &lt;h2&gt;Defining formats&lt;/h2&gt;<a name="line.75"></a>
+<span class="sourceLineNo">076</span> *<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * &lt;p&gt;<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * You can extend a format by calling the {@code with} methods. For example:<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * &lt;/p&gt;<a name="line.79"></a>
+<span class="sourceLineNo">080</span> *<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * &lt;pre&gt;<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * CSVFormat.EXCEL.withNullString(&amp;quot;N/A&amp;quot;).withIgnoreSurroundingSpaces(true);<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * &lt;/pre&gt;<a name="line.83"></a>
+<span class="sourceLineNo">084</span> *<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * &lt;h2&gt;Defining column names&lt;/h2&gt;<a name="line.85"></a>
+<span class="sourceLineNo">086</span> *<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * &lt;p&gt;<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * To define the column names you want to use to access records, write:<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * &lt;/p&gt;<a name="line.89"></a>
+<span class="sourceLineNo">090</span> *<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * &lt;pre&gt;<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * CSVFormat.EXCEL.withHeader(&amp;quot;Col1&amp;quot;, &amp;quot;Col2&amp;quot;, &amp;quot;Col3&amp;quot;);<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * &lt;/pre&gt;<a name="line.93"></a>
+<span class="sourceLineNo">094</span> *<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * &lt;p&gt;<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * Calling {@link #withHeader(String...)} let's you use the given names to address values in a {@link CSVRecord}, and<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * assumes that your CSV source does not contain a first record that also defines column names.<a name="line.97"></a>
+<span class="sourceLineNo">098</span> *<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * If it does, then you are overriding this metadata with your names and you should skip the first record by calling<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * {@link #withSkipHeaderRecord(boolean)} with {@code true}.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * &lt;/p&gt;<a name="line.101"></a>
+<span class="sourceLineNo">102</span> *<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * &lt;h2&gt;Parsing&lt;/h2&gt;<a name="line.103"></a>
+<span class="sourceLineNo">104</span> *<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * &lt;p&gt;<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write:<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * &lt;/p&gt;<a name="line.107"></a>
+<span class="sourceLineNo">108</span> *<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * &lt;pre&gt;<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * Reader in = ...;<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * CSVFormat.EXCEL.withHeader(&amp;quot;Col1&amp;quot;, &amp;quot;Col2&amp;quot;, &amp;quot;Col3&amp;quot;).parse(in);<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * &lt;/pre&gt;<a name="line.112"></a>
+<span class="sourceLineNo">113</span> *<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * &lt;p&gt;<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * For other input types, like resources, files, and URLs, use the static methods on {@link CSVParser}.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * &lt;/p&gt;<a name="line.116"></a>
+<span class="sourceLineNo">117</span> *<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * &lt;h2&gt;Referencing columns safely&lt;/h2&gt;<a name="line.118"></a>
+<span class="sourceLineNo">119</span> *<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * &lt;p&gt;<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * If your source contains a header record, you can simplify your code and safely reference columns, by using<a name="line.121"></a>
+<span class="sourceLineNo">122</span> * {@link #withHeader(String...)} with no arguments:<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * &lt;/p&gt;<a name="line.123"></a>
+<span class="sourceLineNo">124</span> *<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * &lt;pre&gt;<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * CSVFormat.EXCEL.withHeader();<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * &lt;/pre&gt;<a name="line.127"></a>
+<span class="sourceLineNo">128</span> *<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * &lt;p&gt;<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * This causes the parser to read the first record and use its values as column names.<a name="line.130"></a>
+<span class="sourceLineNo">131</span> *<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * Then, call one of the {@link CSVRecord} get method that takes a String column name argument:<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * &lt;/p&gt;<a name="line.133"></a>
+<span class="sourceLineNo">134</span> *<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * &lt;pre&gt;<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * String value = record.get(&amp;quot;Col1&amp;quot;);<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * &lt;/pre&gt;<a name="line.137"></a>
+<span class="sourceLineNo">138</span> *<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * &lt;p&gt;<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * This makes your code impervious to changes in column order in the CSV file.<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * &lt;/p&gt;<a name="line.141"></a>
+<span class="sourceLineNo">142</span> *<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * &lt;h2&gt;Notes&lt;/h2&gt;<a name="line.143"></a>
+<span class="sourceLineNo">144</span> *<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * &lt;p&gt;<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * This class is immutable.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * &lt;/p&gt;<a name="line.147"></a>
+<span class="sourceLineNo">148</span> *<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * @version $Id: CSVFormat.java 1745258 2016-05-23 20:24:33Z ggregory $<a name="line.149"></a>
+<span class="sourceLineNo">150</span> */<a name="line.150"></a>
+<span class="sourceLineNo">151</span>public final class CSVFormat implements Serializable {<a name="line.151"></a>
+<span class="sourceLineNo">152</span><a name="line.152"></a>
+<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
+<span class="sourceLineNo">154</span>     * Predefines formats.<a name="line.154"></a>
+<span class="sourceLineNo">155</span>     *<a name="line.155"></a>
+<span class="sourceLineNo">156</span>     * @since 1.2<a name="line.156"></a>
+<span class="sourceLineNo">157</span>     */<a name="line.157"></a>
+<span class="sourceLineNo">158</span>    public enum Predefined {<a name="line.158"></a>
+<span class="sourceLineNo">159</span><a name="line.159"></a>
+<span class="sourceLineNo">160</span>        /**<a name="line.160"></a>
+<span class="sourceLineNo">161</span>         * @see CSVFormat#DEFAULT<a name="line.161"></a>
+<span class="sourceLineNo">162</span>         */<a name="line.162"></a>
+<span class="sourceLineNo">163</span>        Default(CSVFormat.DEFAULT),<a name="line.163"></a>
+<span class="sourceLineNo">164</span><a name="line.164"></a>
+<span class="sourceLineNo">165</span>        /**<a name="line.165"></a>
+<span class="sourceLineNo">166</span>         * @see CSVFormat#EXCEL<a name="line.166"></a>
+<span class="sourceLineNo">167</span>         */<a name="line.167"></a>
+<span class="sourceLineNo">168</span>        Excel(CSVFormat.EXCEL),<a name="line.168"></a>
+<span class="sourceLineNo">169</span><a name="line.169"></a>
+<span class="sourceLineNo">170</span>        /**<a name="line.170"></a>
+<span class="sourceLineNo">171</span>         * @see CSVFormat#INFORMIX_UNLOAD<a name="line.171"></a>
+<span class="sourceLineNo">172</span>         * @since 1.3<a name="line.172"></a>
+<span class="sourceLineNo">173</span>         */<a name="line.173"></a>
+<span class="sourceLineNo">174</span>        InformixUnload(CSVFormat.INFORMIX_UNLOAD),<a name="line.174"></a>
+<span class="sourceLineNo">175</span><a name="line.175"></a>
+<span class="sourceLineNo">176</span>        /**<a name="line.176"></a>
+<span class="sourceLineNo">177</span>         * @see CSVFormat#INFORMIX_UNLOAD_CSV<a name="line.177"></a>
+<span class="sourceLineNo">178</span>         * @since 1.3<a name="line.178"></a>
+<span class="sourceLineNo">179</span>         */<a name="line.179"></a>
+<span class="sourceLineNo">180</span>        InformixUnloadCsv(CSVFormat.INFORMIX_UNLOAD_CSV),<a name="line.180"></a>
+<span class="sourceLineNo">181</span><a name="line.181"></a>
+<span class="sourceLineNo">182</span>        /**<a name="line.182"></a>
+<span class="sourceLineNo">183</span>         * @see CSVFormat#MYSQL<a name="line.183"></a>
+<span class="sourceLineNo">184</span>         */<a name="line.184"></a>
+<span class="sourceLineNo">185</span>        MySQL(CSVFormat.MYSQL),<a name="line.185"></a>
+<span class="sourceLineNo">186</span><a name="line.186"></a>
+<span class="sourceLineNo">187</span>        /**<a name="line.187"></a>
+<span class="sourceLineNo">188</span>         * @see CSVFormat#RFC4180<a name="line.188"></a>
+<span class="sourceLineNo">189</span>         */<a name="line.189"></a>
+<span class="sourceLineNo">190</span>        RFC4180(CSVFormat.RFC4180),<a name="line.190"></a>
+<span class="sourceLineNo">191</span><a name="line.191"></a>
+<span class="sourceLineNo">192</span>        /**<a name="line.192"></a>
+<span class="sourceLineNo">193</span>         * @see CSVFormat#TDF<a name="line.193"></a>
+<span class="sourceLineNo">194</span>         */<a name="line.194"></a>
+<span class="sourceLineNo">195</span>        TDF(CSVFormat.TDF);<a name="line.195"></a>
+<span class="sourceLineNo">196</span><a name="line.196"></a>
+<span class="sourceLineNo">197</span>        private final CSVFormat format;<a name="line.197"></a>
+<span class="sourceLineNo">198</span><a name="line.198"></a>
+<span class="sourceLineNo">199</span>        Predefined(final CSVFormat format) {<a name="line.199"></a>
+<span class="sourceLineNo">200</span>            this.format = format;<a name="line.200"></a>
+<span class="sourceLineNo">201</span>        }<a name="line.201"></a>
+<span class="sourceLineNo">202</span><a name="line.202"></a>
+<span class="sourceLineNo">203</span>        /**<a name="line.203"></a>
+<span class="sourceLineNo">204</span>         * Gets the format.<a name="line.204"></a>
+<span class="sourceLineNo">205</span>         *<a name="line.205"></a>
+<span class="sourceLineNo">206</span>         * @return the format.<a name="line.206"></a>
+<span class="sourceLineNo">207</span>         */<a name="line.207"></a>
+<span class="sourceLineNo">208</span>        public CSVFormat getFormat() {<a name="line.208"></a>
+<span class="sourceLineNo">209</span>            return format;<a name="line.209"></a>
+<span class="sourceLineNo">210</span>        }<a name="line.210"></a>
+<span class="sourceLineNo">211</span>    }<a name="line.211"></a>
+<span class="sourceLineNo">212</span><a name="line.212"></a>
+<span class="sourceLineNo">213</span>    /**<a name="line.213"></a>
+<span class="sourceLineNo">214</span>     * Standard comma separated format, as for {@link #RFC4180} but allowing empty lines.<a name="line.214"></a>
+<span class="sourceLineNo">215</span>     *<a name="line.215"></a>
+<span class="sourceLineNo">216</span>     * &lt;p&gt;<a name="line.216"></a>
+<span class="sourceLineNo">217</span>     * Settings are:<a name="line.217"></a>
+<span class="sourceLineNo">218</span>     * &lt;/p&gt;<a name="line.218"></a>
+<span class="sourceLineNo">219</span>     * &lt;ul&gt;<a name="line.219"></a>
+<span class="sourceLineNo">220</span>     * &lt;li&gt;withDelimiter(',')&lt;/li&gt;<a name="line.220"></a>
+<span class="sourceLineNo">221</span>     * &lt;li&gt;withQuote('"')&lt;/li&gt;<a name="line.221"></a>
+<span class="sourceLineNo">222</span>     * &lt;li&gt;withRecordSeparator("\r\n")&lt;/li&gt;<a name="line.222"></a>
+<span class="sourceLineNo">223</span>     * &lt;li&gt;withIgnoreEmptyLines(true)&lt;/li&gt;<a name="line.223"></a>
+<span class="sourceLineNo">224</span>     * &lt;/ul&gt;<a name="line.224"></a>
+<span class="sourceLineNo">225</span>     *<a name="line.225"></a>
+<span class="sourceLineNo">226</span>     * @see Predefined#Default<a name="line.226"></a>
+<span class="sourceLineNo">227</span>     */<a name="line.227"></a>
+<span class="sourceLineNo">228</span>    public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null, false, true, CRLF,<a name="line.228"></a>
+<span class="sourceLineNo">229</span>            null, null, null, false, false, false, false, false);<a name="line.229"></a>
+<span class="sourceLineNo">230</span><a name="line.230"></a>
+<span class="sourceLineNo">231</span>    /**<a name="line.231"></a>
+<span class="sourceLineNo">232</span>     * Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is<a name="line.232"></a>
+<span class="sourceLineNo">233</span>     * locale dependent, it might be necessary to customize this format to accommodate to your regional settings.<a name="line.233"></a>
+<span class="sourceLineNo">234</span>     *<a name="line.234"></a>
+<span class="sourceLineNo">235</span>     * &lt;p&gt;<a name="line.235"></a>
+<span class="sourceLineNo">236</span>     * For example for parsing or generating a CSV file on a French system the following format will be used:<a name="line.236"></a>
+<span class="sourceLineNo">237</span>     * &lt;/p&gt;<a name="line.237"></a>
+<span class="sourceLineNo">238</span>     *<a name="line.238"></a>
+<span class="sourceLineNo">239</span>     * &lt;pre&gt;<a name="line.239"></a>
+<span class="sourceLineNo">240</span>     * CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');<a name="line.240"></a>
+<span class="sourceLineNo">241</span>     * &lt;/pre&gt;<a name="line.241"></a>
+<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
+<span class="sourceLineNo">243</span>     * &lt;p&gt;<a name="line.243"></a>
+<span class="sourceLineNo">244</span>     * Settings are:<a name="line.244"></a>
+<span class="sourceLineNo">245</span>     * &lt;/p&gt;<a name="line.245"></a>
+<span class="sourceLineNo">246</span>     * &lt;ul&gt;<a name="line.246"></a>
+<span class="sourceLineNo">247</span>     * &lt;li&gt;{@link #withDelimiter(char) withDelimiter(',')}&lt;/li&gt;<a name="line.247"></a>
+<span class="sourceLineNo">248</span>     * &lt;li&gt;{@link #withQuote(char) withQuote('"')}&lt;/li&gt;<a name="line.248"></a>
+<span class="sourceLineNo">249</span>     * &lt;li&gt;{@link #withRecordSeparator(String) withRecordSeparator("\r\n")}&lt;/li&gt;<a name="line.249"></a>
+<span class="sourceLineNo">250</span>     * &lt;li&gt;{@link #withIgnoreEmptyLines(boolean) withIgnoreEmptyLines(false)}&lt;/li&gt;<a name="line.250"></a>
+<span class="sourceLineNo">251</span>     * &lt;li&gt;{@link #withAllowMissingColumnNames(boolean) withAllowMissingColumnNames(true)}&lt;/li&gt;<a name="line.251"></a>
+<span class="sourceLineNo">252</span>     * &lt;/ul&gt;<a name="line.252"></a>
+<span class="sourceLineNo">253</span>     * &lt;p&gt;<a name="line.253"></a>
+<span class="sourceLineNo">254</span>     * Note: this is currently like {@link #RFC4180} plus {@link #withAllowMissingColumnNames(boolean)<a name="line.254"></a>
+<span class="sourceLineNo">255</span>     * withAllowMissingColumnNames(true)}.<a name="line.255"></a>
+<span class="sourceLineNo">256</span>     * &lt;/p&gt;<a name="line.256"></a>
+<span class="sourceLineNo">257</span>     *<a name="line.257"></a>
+<span class="sourceLineNo">258</span>     * @see Predefined#Excel<a name="line.258"></a>
+<span class="sourceLineNo">259</span>     */<a name="line.259"></a>
+<span class="sourceLineNo">260</span>    public static final CSVFormat EXCEL = DEFAULT.withIgnoreEmptyLines(false).withAllowMissingColumnNames();<a name="line.260"></a>
+<span class="sourceLineNo">261</span><a name="line.261"></a>
+<span class="sourceLineNo">262</span>    /**<a name="line.262"></a>
+<span class="sourceLineNo">263</span>     * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation.<a name="line.263"></a>
+<span class="sourceLineNo">264</span>     *<a name="line.264"></a>
+<span class="sourceLineNo">265</span>     * &lt;p&gt;<a name="line.265"></a>
+<span class="sourceLineNo">266</span>     * This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special<a name="line.266"></a>
+<span class="sourceLineNo">267</span>     * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}.<a name="line.267"></a>
+<span class="sourceLineNo">268</span>     * &lt;/p&gt;<a name="line.268"></a>
+<span class="sourceLineNo">269</span>     *<a name="line.269"></a>
+<span class="sourceLineNo">270</span>     * &lt;p&gt;<a name="line.270"></a>
+<span class="sourceLineNo">271</span>     * Settings are:<a name="line.271"></a>
+<span class="sourceLineNo">272</span>     * &lt;/p&gt;<a name="line.272"></a>
+<span class="sourceLineNo">273</span>     * &lt;ul&gt;<a name="line.273"></a>
+<span class="sourceLineNo">274</span>     * &lt;li&gt;withDelimiter(',')&lt;/li&gt;<a name="line.274"></a>
+<span class="sourceLineNo">275</span>     * &lt;li&gt;withQuote("\"")&lt;/li&gt;<a name="line.275"></a>
+<span class="sourceLineNo">276</span>     * &lt;li&gt;withRecordSeparator('\n')&lt;/li&gt;<a name="line.276"></a>
+<span class="sourceLineNo">277</span>     * &lt;li&gt;withEscape('\\')&lt;/li&gt;<a name="line.277"></a>
+<span class="sourceLineNo">278</span>     * &lt;/ul&gt;<a name="line.278"></a>
+<span class="sourceLineNo">279</span>     *<a name="line.279"></a>
+<span class="sourceLineNo">280</span>     * @see Predefined#MySQL<a name="line.280"></a>
+<span class="sourceLineNo">281</span>     * @see &lt;a href=<a name="line.281"></a>
+<span class="sourceLineNo">282</span>     *      "http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm"&gt;<a name="line.282"></a>
+<span class="sourceLineNo">283</span>     *      http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm&lt;/a&gt;<a name="line.283"></a>
+<span class="sourceLineNo">284</span>     * @since 1.3<a name="line.284"></a>
+<span class="sourceLineNo">285</span>     */<a name="line.285"></a>
+<span class="sourceLineNo">286</span>    public static final CSVFormat INFORMIX_UNLOAD = DEFAULT.withDelimiter(PIPE).withEscape(BACKSLASH)<a name="line.286"></a>
+<span class="sourceLineNo">287</span>            .withQuote(DOUBLE_QUOTE_CHAR).withRecordSeparator(LF);<a name="line.287"></a>
+<span class="sourceLineNo">288</span><a name="line.288"></a>
+<span class="sourceLineNo">289</span>    /**<a name="line.289"></a>
+<span class="sourceLineNo">290</span>     * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation (escaping is disabled.)<a name="line.290"></a>
+<span class="sourceLineNo">291</span>     *<a name="line.291"></a>
+<span class="sourceLineNo">292</span>     * &lt;p&gt;<a name="line.292"></a>
+<span class="sourceLineNo">293</span>     * This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special<a name="line.293"></a>
+<span class="sourceLineNo">294</span>     * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}.<a name="line.294"></a>
+<span class="sourceLineNo">295</span>     * &lt;/p&gt;<a name="line.295"></a>
+<span class="sourceLineNo">296</span>     *<a name="line.296"></a>
+<span class="sourceLineNo">297</span>     * &lt;p&gt;<a name="line.297"></a>
+<span class="sourceLineNo">298</span>     * Settings are:<a name="line.298"></a>
+<span class="sourceLineNo">299</span>     * &lt;/p&gt;<a name="line.299"></a>
+<span class="sourceLineNo">300</span>     * &lt;ul&gt;<a name="line.300"></a>
+<span class="sourceLineNo">301</span>     * &lt;li&gt;withDelimiter(',')&lt;/li&gt;<a name="line.301"></a>
+<span class="sourceLineNo">302</span>     * &lt;li&gt;withQuote("\"")&lt;/li&gt;<a name="line.302"></a>
+<span class="sourceLineNo">303</span>     * &lt;li&gt;withRecordSeparator('\n')&lt;/li&gt;<a name="line.303"></a>
+<span class="sourceLineNo">304</span>     * &lt;/ul&gt;<a name="line.304"></a>
+<span class="sourceLineNo">305</span>     *<a name="line.305"></a>
+<span class="sourceLineNo">306</span>     * @see Predefined#MySQL<a name="line.306"></a>
+<span class="sourceLineNo">307</span>     * @see &lt;a href=<a name="line.307"></a>
+<span class="sourceLineNo">308</span>     *      "http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm"&gt;<a name="line.308"></a>
+<span class="sourceLineNo">309</span>     *      http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm&lt;/a&gt;<a name="line.309"></a>
+<span class="sourceLineNo">310</span>     * @since 1.3<a name="line.310"></a>
+<span class="sourceLineNo">311</span>     */<a name="line.311"></a>
+<span class="sourceLineNo">312</span>    public static final CSVFormat INFORMIX_UNLOAD_CSV = DEFAULT.withDelimiter(COMMA).withQuote(DOUBLE_QUOTE_CHAR)<a name="line.312"></a>
+<span class="sourceLineNo">313</span>            .withRecordSeparator(LF);<a name="line.313"></a>
+<span class="sourceLineNo">314</span><a name="line.314"></a>
+<span class="sourceLineNo">315</span>    /**<a name="line.315"></a>
+<span class="sourceLineNo">316</span>     * Default MySQL format used by the {@code SELECT INTO OUTFILE} and {@code LOAD DATA INFILE} operations.<a name="line.316"></a>
+<span class="sourceLineNo">317</span>     *<a name="line.317"></a>
+<span class="sourceLineNo">318</span>     * &lt;p&gt;<a name="line.318"></a>
+<span class="sourceLineNo">319</span>     * This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special<a name="line.319"></a>
+<span class="sourceLineNo">320</span>     * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}.<a name="line.320"></a>
+<span class="sourceLineNo">321</span>     * &lt;/p&gt;<a name="line.321"></a>
+<span class="sourceLineNo">322</span>     *<a name="line.322"></a>
+<span class="sourceLineNo">323</span>     * &lt;p&gt;<a name="line.323"></a>
+<span class="sourceLineNo">324</span>     * Settings are:<a name="line.324"></a>
+<span class="sourceLineNo">325</span>     * &lt;/p&gt;<a name="line.325"></a>
+<span class="sourceLineNo">326</span>     * &lt;ul&gt;<a name="line.326"></a>
+<span class="sourceLineNo">327</span>     * &lt;li&gt;withDelimiter('\t')&lt;/li&gt;<a name="line.327"></a>
+<span class="sourceLineNo">328</span>     * &lt;li&gt;withQuote(null)&lt;/li&gt;<a name="line.328"></a>
+<span class="sourceLineNo">329</span>     * &lt;li&gt;withRecordSeparator('\n')&lt;/li&gt;<a name="line.329"></a>
+<span class="sourceLineNo">330</span>     * &lt;li&gt;withIgnoreEmptyLines(false)&lt;/li&gt;<a name="line.330"></a>
+<span class="sourceLineNo">331</span>     * &lt;li&gt;withEscape('\\')&lt;/li&gt;<a name="line.331"></a>
+<span class="sourceLineNo">332</span>     * &lt;li&gt;withNullString("\\N")&lt;/li&gt;<a name="line.332"></a>
+<span class="sourceLineNo">333</span>     * &lt;/ul&gt;<a name="line.333"></a>
+<span class="sourceLineNo">334</span>     *<a name="line.334"></a>
+<span class="sourceLineNo">335</span>     * @see Predefined#MySQL<a name="line.335"></a>
+<span class="sourceLineNo">336</span>     * @see &lt;a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html"&gt; http://dev.mysql.com/doc/refman/5.1/en/load<a name="line.336"></a>
+<span class="sourceLineNo">337</span>     *      -data.html&lt;/a&gt;<a name="line.337"></a>
+<span class="sourceLineNo">338</span>     */<a name="line.338"></a>
+<span class="sourceLineNo">339</span>    public static final CSVFormat MYSQL = DEFAULT.withDelimiter(TAB).withEscape(BACKSLASH).withIgnoreEmptyLines(false)<a name="line.339"></a>
+<span class="sourceLineNo">340</span>            .withQuote(null).withRecordSeparator(LF).withNullString("\\N");<a name="line.340"></a>
+<span class="sourceLineNo">341</span><a name="line.341"></a>
+<span class="sourceLineNo">342</span>    /**<a name="line.342"></a>
+<span class="sourceLineNo">343</span>     * Comma separated format as defined by &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.343"></a>
+<span class="sourceLineNo">344</span>     *<a name="line.344"></a>
+<span class="sourceLineNo">345</span>     * &lt;p&gt;<a name="line.345"></a>
+<span class="sourceLineNo">346</span>     * Settings are:<a name="line.346"></a>
+<span class="sourceLineNo">347</span>     * &lt;/p&gt;<a name="line.347"></a>
+<span class="sourceLineNo">348</span>     * &lt;ul&gt;<a name="line.348"></a>
+<span class="sourceLineNo">349</span>     * &lt;li&gt;withDelimiter(',')&lt;/li&gt;<a name="line.349"></a>
+<span class="sourceLineNo">350</span>     * &lt;li&gt;withQuote('"')&lt;/li&gt;<a name="line.350"></a>
+<span class="sourceLineNo">351</span>     * &lt;li&gt;withRecordSeparator("\r\n")&lt;/li&gt;<a name="line.351"></a>
+<span class="sourceLineNo">352</span>     * &lt;li&gt;withIgnoreEmptyLines(false)&lt;/li&gt;<a name="line.352"></a>
+<span class="sourceLineNo">353</span>     * &lt;/ul&gt;<a name="line.353"></a>
+<span class="sourceLineNo">354</span>     *<a name="line.354"></a>
+<span class="sourceLineNo">355</span>     * @see Predefined#RFC4180<a name="line.355"></a>
+<span class="sourceLineNo">356</span>     */<a name="line.356"></a>
+<span class="sourceLineNo">357</span>    public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);<a name="line.357"></a>
+<span class="sourceLineNo">358</span><a name="line.358"></a>
+<span class="sourceLineNo">359</span>    private static final long serialVersionUID = 1L;<a name="line.359"></a>
+<span class="sourceLineNo">360</span><a name="line.360"></a>
+<span class="sourceLineNo">361</span>    /**<a name="line.361"></a>
+<span class="sourceLineNo">362</span>     * Tab-delimited format.<a name="line.362"></a>
+<span class="sourceLineNo">363</span>     *<a name="line.363"></a>
+<span class="sourceLineNo">364</span>     * &lt;p&gt;<a name="line.364"></a>
+<span class="sourceLineNo">365</span>     * Settings are:<a name="line.365"></a>
+<span class="sourceLineNo">366</span>     * &lt;/p&gt;<a name="line.366"></a>
+<span class="sourceLineNo">367</span>     * &lt;ul&gt;<a name="line.367"></a>
+<span class="sourceLineNo">368</span>     * &lt;li&gt;withDelimiter('\t')&lt;/li&gt;<a name="line.368"></a>
+<span class="sourceLineNo">369</span>     * &lt;li&gt;withQuote('"')&lt;/li&gt;<a name="line.369"></a>
+<span class="sourceLineNo">370</span>     * &lt;li&gt;withRecordSeparator("\r\n")&lt;/li&gt;<a name="line.370"></a>
+<span class="sourceLineNo">371</span>     * &lt;li&gt;withIgnoreSurroundingSpaces(true)&lt;/li&gt;<a name="line.371"></a>
+<span class="sourceLineNo">372</span>     * &lt;/ul&gt;<a name="line.372"></a>
+<span class="sourceLineNo">373</span>     *<a name="line.373"></a>
+<span class="sourceLineNo">374</span>     * @see Predefined#TDF<a name="line.374"></a>
+<span class="sourceLineNo">375</span>     */<a name="line.375"></a>
+<span class="sourceLineNo">376</span>    public static final CSVFormat TDF = DEFAULT.withDelimiter(TAB).withIgnoreSurroundingSpaces();<a name="line.376"></a>
+<span class="sourceLineNo">377</span><a name="line.377"></a>
+<span class="sourceLineNo">378</span>    /**<a name="line.378"></a>
+<span class="sourceLineNo">379</span>     * Returns true if the given character is a line break character.<a name="line.379"></a>
+<span class="sourceLineNo">380</span>     *<a name="line.380"></a>
+<span class="sourceLineNo">381</span>     * @param c<a name="line.381"></a>
+<span class="sourceLineNo">382</span>     *            the character to check<a name="line.382"></a>
+<span class="sourceLineNo">383</span>     *<a name="line.383"></a>
+<span class="sourceLineNo">384</span>     * @return true if &lt;code&gt;c&lt;/code&gt; is a line break character<a name="line.384"></a>
+<span class="sourceLineNo">385</span>     */<a name="line.385"></a>
+<span class="sourceLineNo">386</span>    private static boolean isLineBreak(final char c) {<a name="line.386"></a>
+<span class="sourceLineNo">387</span>        return c == LF || c == CR;<a name="line.387"></a>
+<span class="sourceLineNo">388</span>    }<a name="line.388"></a>
+<span class="sourceLineNo">389</span><a name="line.389"></a>
+<span class="sourceLineNo">390</span>    /**<a name="line.390"></a>
+<span class="sourceLineNo">391</span>     * Returns true if the given character is a line break character.<a name="line.391"></a>
+<span class="sourceLineNo">392</span>     *<a name="line.392"></a>
+<span class="sourceLineNo">393</span>     * @param c<a name="line.393"></a>
+<span class="sourceLineNo">394</span>     *            the character to check, may be null<a name="line.394"></a>
+<span class="sourceLineNo">395</span>     *<a name="line.395"></a>
+<span class="sourceLineNo">396</span>     * @return true if &lt;code&gt;c&lt;/code&gt; is a line break character (and not null)<a name="line.396"></a>
+<span class="sourceLineNo">397</span>     */<a name="line.397"></a>
+<span class="sourceLineNo">398</span>    private static boolean isLineBreak(final Character c) {<a name="line.398"></a>
+<span class="sourceLineNo">399</span>        return c != null &amp;&amp; isLineBreak(c.charValue());<a name="line.399"></a>
+<span class="sourceLineNo">400</span>    }<a name="line.400"></a>
+<span class="sourceLineNo">401</span><a name="line.401"></a>
+<span class="sourceLineNo">402</span>    /**<a name="line.402"></a>
+<span class="sourceLineNo">403</span>     * Creates a new CSV format with the specified delimiter.<a name="line.403"></a>
+<span class="sourceLineNo">404</span>     *<a name="line.404"></a>
+<span class="sourceLineNo">405</span>     * &lt;p&gt;<a name="line.405"></a>
+<span class="sourceLineNo">406</span>     * Use this method if you want to create a CSVFormat from scratch. All fields but the delimiter will be initialized<a name="line.406"></a>
+<span class="sourceLineNo">407</span>     * with null/false.<a name="line.407"></a>
+<span class="sourceLineNo">408</span>     * &lt;/p&gt;<a name="line.408"></a>
+<span class="sourceLineNo">409</span>     *<a name="line.409"></a>
+<span class="sourceLineNo">410</span>     * @param delimiter<a name="line.410"></a>
+<span class="sourceLineNo">411</span>     *            the char used for value separation, must not be a line break character<a name="line.411"></a>
+<span class="sourceLineNo">412</span>     * @return a new CSV format.<a name="line.412"></a>
+<span class="sourceLineNo">413</span>     * @throws IllegalArgumentException<a name="line.413"></a>
+<span class="sourceLineNo">414</span>     *             if the delimiter is a line break character<a name="line.414"></a>
+<span class="sourceLineNo">415</span>     *<a name="line.415"></a>
+<span class="sourceLineNo">416</span>     * @see #DEFAULT<a name="line.416"></a>
+<span class="sourceLineNo">417</span>     * @see #RFC4180<a name="line.417"></a>
+<span class="sourceLineNo">418</span>     * @see #MYSQL<a name="line.418"></a>
+<span class="sourceLineNo">419</span>     * @see #EXCEL<a name="line.419"></a>
+<span class="sourceLineNo">420</span>     * @see #TDF<a name="line.420"></a>
+<span class="sourceLineNo">421</span>     */<a name="line.421"></a>
+<span class="sourceLineNo">422</span>    public static CSVFormat newFormat(final char delimiter) {<a name="line.422"></a>
+<span class="sourceLineNo">423</span>        return new CSVFormat(delimiter, null, null, null, null, false, false, null, null, null, null, false, false,<a name="line.423"></a>
+<span class="sourceLineNo">424</span>                false, false, false);<a name="line.424"></a>
+<span class="sourceLineNo">425</span>    }<a name="line.425"></a>
+<span class="sourceLineNo">426</span><a name="line.426"></a>
+<span class="sourceLineNo">427</span>    /**<a name="line.427"></a>
+<span class="sourceLineNo">428</span>     * Gets one of the predefined formats from {@link CSVFormat.Predefined}.<a name="line.428"></a>
+<span class="sourceLineNo">429</span>     *<a name="line.429"></a>
+<span class="sourceLineNo">430</span>     * @param format<a name="line.430"></a>
+<span class="sourceLineNo">431</span>     *            name<a name="line.431"></a>
+<span class="sourceLineNo">432</span>     * @return one of the predefined formats<a name="line.432"></a>
+<span class="sourceLineNo">433</span>     * @since 1.2<a name="line.433"></a>
+<span class="sourceLineNo">434</span>     */<a name="line.434"></a>
+<span class="sourceLineNo">435</span>    public static CSVFormat valueOf(final String format) {<a name="line.435"></a>
+<span class="sourceLineNo">436</span>        return CSVFormat.Predefined.valueOf(format).getFormat();<a name="line.436"></a>
+<span class="sourceLineNo">437</span>    }<a name="line.437"></a>
+<span class="sourceLineNo">438</span><a name="line.438"></a>
+<span class="sourceLineNo">439</span>    private final boolean allowMissingColumnNames;<a name="line.439"></a>
+<span class="sourceLineNo">440</span><a name="line.440"></a>
+<span class="sourceLineNo">441</span>    private final Character commentMarker; // null if commenting is disabled<a name="line.441"></a>
+<span class="sourceLineNo">442</span><a name="line.442"></a>
+<span class="sourceLineNo">443</span>    private final char delimiter;<a name="line.443"></a>
+<span class="sourceLineNo">444</span><a name="line.444"></a>
+<span class="sourceLineNo">445</span>    private final Character escapeCharacter; // null if escaping is disabled<a name="line.445"></a>
+<span class="sourceLineNo">446</span><a name="line.446"></a>
+<span class="sourceLineNo">447</span>    private final String[] header; // array of header column names<a name="line.447"></a>
+<span class="sourceLineNo">448</span><a name="line.448"></a>
+<span class="sourceLineNo">449</span>    private final String[] headerComments; // array of header comment lines<a name="line.449"></a>
+<span class="sourceLineNo">450</span><a name="line.450"></a>
+<span class="sourceLineNo">451</span>    private final boolean ignoreEmptyLines;<a name="line.451"></a>
+<span class="sourceLineNo">452</span><a name="line.452"></a>
+<span class="sourceLineNo">453</span>    private final boolean ignoreHeaderCase; // should ignore header names case<a name="line.453"></a>
+<span class="sourceLineNo">454</span><a name="line.454"></a>
+<span class="sourceLineNo">455</span>    private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values?<a name="line.455"></a>
+<span class="sourceLineNo">456</span><a name="line.456"></a>
+<span class="sourceLineNo">457</span>    private final String nullString; // the string to be used for null values<a name="line.457"></a>
+<span class="sourceLineNo">458</span><a name="line.458"></a>
+<span class="sourceLineNo">459</span>    private final Character quoteCharacter; // null if quoting is disabled<a name="line.459"></a>
+<span class="sourceLineNo">460</span><a name="line.460"></a>
+<span class="sourceLineNo">461</span>    private final QuoteMode quoteMode;<a name="line.461"></a>
+<span class="sourceLineNo">462</span><a name="line.462"></a>
+<span class="sourceLineNo">463</span>    private final String recordSeparator; // for outputs<a name="line.463"></a>
+<span class="sourceLineNo">464</span><a name="line.464"></a>
+<span class="sourceLineNo">465</span>    private final boolean skipHeaderRecord;<a name="line.465"></a>
+<span class="sourceLineNo">466</span><a name="line.466"></a>
+<span class="sourceLineNo">467</span>    private final boolean trailingDelimiter;<a name="line.467"></a>
+<span class="sourceLineNo">468</span><a name="line.468"></a>
+<span class="sourceLineNo">469</span>    private final boolean trim;<a name="line.469"></a>
+<span class="sourceLineNo">470</span><a name="line.470"></a>
+<span class="sourceLineNo">471</span>    /**<a name="line.471"></a>
+<span class="sourceLineNo">472</span>     * Creates a customized CSV format.<a name="line.472"></a>
+<span class="sourceLineNo">473</span>     *<a name="line.473"></a>
+<span class="sourceLineNo">474</span>     * @param delimiter<a name="line.474"></a>
+<span class="sourceLineNo">475</span>     *            the char used for value separation, must not be a line break character<a name="line.475"></a>
+<span class="sourceLineNo">476</span>     * @param quoteChar<a name="line.476"></a>
+<span class="sourceLineNo">477</span>     *            the Character used as value encapsulation marker, may be {@code null} to disable<a name="line.477"></a>
+<span class="sourceLineNo">478</span>     * @param quoteMode<a name="line.478"></a>
+<span class="sourceLineNo">479</span>     *            the quote mode<a name="line.479"></a>
+<span class="sourceLineNo">480</span>     * @param commentStart<a name="line.480"></a>
+<span class="sourceLineNo">481</span>     *            the Character used for comment identification, may be {@code null} to disable<a name="line.481"></a>
+<span class="sourceLineNo">482</span>     * @param escape<a name="line.482"></a>
+<span class="sourceLineNo">483</span>     *            the Character used to escape special characters in values, may be {@code null} to disable<a name="line.483"></a>
+<span class="sourceLineNo">484</span>     * @param ignoreSurroundingSpaces<a name="line.484"></a>
+<span class="sourceLineNo">485</span>     *            {@code true} when whitespaces enclosing values should be ignored<a name="line.485"></a>
+<span class="sourceLineNo">486</span>     * @param ignoreEmptyLines<a name="line.486"></a>
+<span class="sourceLineNo">487</span>     *            {@code true} when the parser should skip empty lines<a name="line.487"></a>
+<span class="sourceLineNo">488</span>     * @param recordSeparator<a name="line.488"></a>
+<span class="sourceLineNo">489</span>     *            the line separator to use for output<a name="line.489"></a>
+<span class="sourceLineNo">490</span>     * @param nullString<a name="line.490"></a>
+<span class="sourceLineNo">491</span>     *            the line separator to use for output<a name="line.491"></a>
+<span class="sourceLineNo">492</span>     * @param headerComments<a name="line.492"></a>
+<span class="sourceLineNo">493</span>     *            the comments to be printed by the Printer before the actual CSV data<a name="line.493"></a>
+<span class="sourceLineNo">494</span>     * @param header<a name="line.494"></a>
+<span class="sourceLineNo">495</span>     *            the header<a name="line.495"></a>
+<span class="sourceLineNo">496</span>     * @param skipHeaderRecord<a name="line.496"></a>
+<span class="sourceLineNo">497</span>     *            TODO<a name="line.497"></a>
+<span class="sourceLineNo">498</span>     * @param allowMissingColumnNames<a name="line.498"></a>
+<span class="sourceLineNo">499</span>     *            TODO<a name="line.499"></a>
+<span class="sourceLineNo">500</span>     * @param ignoreHeaderCase<a name="line.500"></a>
+<span class="sourceLineNo">501</span>     *            TODO<a name="line.501"></a>
+<span class="sourceLineNo">502</span>     * @param trim<a name="line.502"></a>
+<span class="sourceLineNo">503</span>     *            TODO<a name="line.503"></a>
+<span class="sourceLineNo">504</span>     * @param trailingDelimiter<a name="line.504"></a>
+<span class="sourceLineNo">505</span>     *            TODO<a name="line.505"></a>
+<span class="sourceLineNo">506</span>     * @throws IllegalArgumentException<a name="line.506"></a>
+<span class="sourceLineNo">507</span>     *             if the delimiter is a line break character<a name="line.507"></a>
+<span class="sourceLineNo">508</span>     */<a name="line.508"></a>
+<span class="sourceLineNo">509</span>    private CSVFormat(final char delimiter, final Character quoteChar, final QuoteMode quoteMode,<a name="line.509"></a>
+<span class="sourceLineNo">510</span>            final Character commentStart, final Character escape, final boolean ignoreSurroundingSpaces,<a name="line.510"></a>
+<span class="sourceLineNo">511</span>            final boolean ignoreEmptyLines, final String recordSeparator, final String nullString,<a name="line.511"></a>
+<span class="sourceLineNo">512</span>            final Object[] headerComments, final String[] header, final boolean skipHeaderRecord,<a name="line.512"></a>
+<span class="sourceLineNo">513</span>            final boolean allowMissingColumnNames, final boolean ignoreHeaderCase, final boolean trim,<a name="line.513"></a>
+<span class="sourceLineNo">514</span>            final boolean trailingDelimiter) {<a name="line.514"></a>
+<span class="sourceLineNo">515</span>        this.delimiter = delimiter;<a name="line.515"></a>
+<span class="sourceLineNo">516</span>        this.quoteCharacter = quoteChar;<a name="line.516"></a>
+<span class="sourceLineNo">517</span>        this.quoteMode = quoteMode;<a name="line.517"></a>
+<span class="sourceLineNo">518</span>        this.commentMarker = commentStart;<a name="line.518"></a>
+<span class="sourceLineNo">519</span>        this.escapeCharacter = escape;<a name="line.519"></a>
+<span class="sourceLineNo">520</span>        this.ignoreSurroundingSpaces = ignoreSurroundingSpaces;<a name="line.520"></a>
+<span class="sourceLineNo">521</span>        this.allowMissingColumnNames = allowMissingColumnNames;<a name="line.521"></a>
+<span class="sourceLineNo">522</span>        this.ignoreEmptyLines = ignoreEmptyLines;<a name="line.522"></a>
+<span class="sourceLineNo">523</span>        this.recordSeparator = recordSeparator;<a name="line.523"></a>
+<span class="sourceLineNo">524</span>        this.nullString = nullString;<a name="line.524"></a>
+<span class="sourceLineNo">525</span>        this.headerComments = toStringArray(headerComments);<a name="line.525"></a>
+<span class="sourceLineNo">526</span>        this.header = header == null ? null : header.clone();<a name="line.526"></a>
+<span class="sourceLineNo">527</span>        this.skipHeaderRecord = skipHeaderRecord;<a name="line.527"></a>
+<span class="sourceLineNo">528</span>        this.ignoreHeaderCase = ignoreHeaderCase;<a name="line.528"></a>
+<span class="sourceLineNo">529</span>        this.trailingDelimiter = trailingDelimiter;<a name="line.529"></a>
+<span class="sourceLineNo">530</span>        this.trim = trim;<a name="line.530"></a>
+<span class="sourceLineNo">531</span>        validate();<a name="line.531"></a>
+<span class="sourceLineNo">532</span>    }<a name="line.532"></a>
+<span class="sourceLineNo">533</span><a name="line.533"></a>
+<span class="sourceLineNo">534</span>    @Override<a name="line.534"></a>
+<span class="sourceLineNo">535</span>    public boolean equals(final Object obj) {<a name="line.535"></a>
+<span class="sourceLineNo">536</span>        if (this == obj) {<a name="line.536"></a>
+<span class="sourceLineNo">537</span>            return true;<a name="line.537"></a>
+<span class="sourceLineNo">538</span>        }<a name="line.538"></a>
+<span class="sourceLineNo">539</span>        if (obj == null) {<a name="line.539"></a>
+<span class="sourceLineNo">540</span>            return false;<a name="line.540"></a>
+<span class="sourceLineNo">541</span>        }<a name="line.541"></a>
+<span class="sourceLineNo">542</span>        if (getClass() != obj.getClass()) {<a name="line.542"></a>
+<span class="sourceLineNo">543</span>            return false;<a name="line.543"></a>
+<span class="sourceLineNo">544</span>        }<a name="line.544"></a>
+<span class="sourceLineNo">545</span><a name="line.545"></a>
+<span class="sourceLineNo">546</span>        final CSVFormat other = (CSVFormat) obj;<a name="line.546"></a>
+<span class="sourceLineNo">547</span>        if (delimiter != other.delimiter) {<a name="line.547"></a>
+<span class="sourceLineNo">548</span>            return false;<a name="line.548"></a>
+<span class="sourceLineNo">549</span>        }<a name="line.549"></a>
+<span class="sourceLineNo">550</span>        if (quoteMode != other.quoteMode) {<a name="line.550"></a>
+<span class="sourceLineNo">551</span>            return false;<a name="line.551"></a>
+<span class="sourceLineNo">552</span>        }<a name="line.552"></a>
+<span class="sourceLineNo">553</span>        if (quoteCharacter == null) {<a name="line.553"></a>
+<span class="sourceLineNo">554</span>            if (other.quoteCharacter != null) {<a name="line.554"></a>
+<span class="sourceLineNo">555</span>                return false;<a name="line.555"></a>
+<span class="sourceLineNo">556</span>            }<a name="line.556"></a>
+<span class="sourceLineNo">557</span>        } else if (!quoteCharacter.equals(other.quoteCharacter)) {<a name="line.557"></a>
+<span class="sourceLineNo">558</span>            return false;<a name="line.558"></a>
+<span class="sourceLineNo">559</span>        }<a name="line.559"></a>
+<span class="sourceLineNo">560</span>        if (commentMarker == null) {<a name="line.560"></a>
+<span class="sourceLineNo">561</span>            if (other.commentMarker != null) {<a name="line.561"></a>
+<span class="sourceLineNo">562</span>                return false;<a name="line.562"></a>
+<span class="sourceLineNo">563</span>            }<a name="line.563"></a>
+<span class="sourceLineNo">564</span>        } else if (!commentMarker.equals(other.commentMarker)) {<a name="line.564"></a>
+<span class="sourceLineNo">565</span>            return false;<a name="line.565"></a>
+<span class="sourceLineNo">566</span>        }<a name="line.566"></a>
+<span class="sourceLineNo">567</span>        if (escapeCharacter == null) {<a name="line.567"></a>
+<span class="sourceLineNo">568</span>            if (other.escapeCharacter != null) {<a name="line.568"></a>
+<span class="sourceLineNo">569</span>                return false;<a name="line.569"></a>
+<span class="sourceLineNo">570</span>            }<a name="line.570"></a>
+<span class="sourceLineNo">571</span>        } else if (!escapeCharacter.equals(other.escapeCharacter)) {<a name="line.571"></a>
+<span class="sourceLineNo">572</span>            return false;<a name="line.572"></a>
+<span class="sourceLineNo">573</span>        }<a name="line.573"></a>
+<span class="sourceLineNo">574</span>        if (nullString == null) {<a name="line.574"></a>
+<span class="sourceLineNo">575</span>            if (other.nullString != null) {<a name="line.575"></a>
+<span class="sourceLineNo">576</span>                return false;<a name="line.576"></a>
+<span class="sourceLineNo">577</span>            }<a name="line.577"></a>
+<span class="sourceLineNo">578</span>        } else if (!nullString.equals(other.nullString)) {<a name="line.578"></a>
+<span class="sourceLineNo">579</span>            return false;<a name="line.579"></a>
+<span class="sourceLineNo">580</span>        }<a name="line.580"></a>
+<span class="sourceLineNo">581</span>        if (!Arrays.equals(header, other.header)) {<a name="line.581"></a>
+<span class="sourceLineNo">582</span>            return false;<a name="line.582"></a>
+<span class="sourceLineNo">583</span>        }<a name="line.583"></a>
+<span class="sourceLineNo">584</span>        if (ignoreSurroundingSpaces != other.ignoreSurroundingSpaces) {<a name="line.584"></a>
+<span class="sourceLineNo">585</span>            return false;<a name="line.585"></a>
+<span class="sourceLineNo">586</span>        }<a name="line.586"></a>
+<span class="sourceLineNo">587</span>        if (ignoreEmptyLines != other.ignoreEmptyLines) {<a name="line.587"></a>
+<span class="sourceLineNo">588</span>            return false;<a name="line.588"></a>
+<span class="sourceLineNo">589</span>        }<a name="line.589"></a>
+<span class="sourceLineNo">590</span>        if (skipHeaderRecord != other.skipHeaderRecord) {<a name="line.590"></a>
+<span class="sourceLineNo">591</span>            return false;<a name="line.591"></a>
+<span class="sourceLineNo">592</span>        }<a name="line.592"></a>
+<span class="sourceLineNo">593</span>        if (recordSeparator == null) {<a name="line.593"></a>
+<span class="sourceLineNo">594</span>            if (other.recordSeparator != null) {<a name="line.594"></a>
+<span class="sourceLineNo">595</span>                return false;<a name="line.595"></a>
+<span class="sourceLineNo">596</span>            }<a name="line.596"></a>
+<span class="sourceLineNo">597</span>        } else if (!recordSeparator.equals(other.recordSeparator)) {<a name="line.597"></a>
+<span class="sourceLineNo">598</span>            return false;<a name="line.598"></a>
+<span class="sourceLineNo">599</span>        }<a name="line.599"></a>
+<span class="sourceLineNo">600</span>        return true;<a name="line.600"></a>
+<span class="sourceLineNo">601</span>    }<a name="line.601"></a>
+<span class="sourceLineNo">602</span><a name="line.602"></a>
+<span class="sourceLineNo">603</span>    /**<a name="line.603"></a>
+<span class="sourceLineNo">604</span>     * Formats the specified values.<a name="line.604"></a>
+<span class="sourceLineNo">605</span>     *<a name="line.605"></a>
+<span class="sourceLineNo">606</span>     * @param values<a name="line.606"></a>
+<span class="sourceLineNo">607</span>     *            the values to format<a name="line.607"></a>
+<span class="sourceLineNo">608</span>     * @return the formatted values<a name="line.608"></a>
+<span class="sourceLineNo">609</span>     */<a name="line.609"></a>
+<span class="sourceLineNo">610</span>    public String format(final Object... values) {<a name="line.610"></a>
+<span class="sourceLineNo">611</span>        final StringWriter out = new StringWriter();<a name="line.611"></a>
+<span class="sourceLineNo">612</span>        try {<a name="line.612"></a>
+<span class="sourceLineNo">613</span>            new CSVPrinter(out, this).printRecord(values);<a name="line.613"></a>
+<span class="sourceLineNo">614</span>            return out.toString().trim();<a name="line.614"></a>
+<span class="sourceLineNo">615</span>        } catch (final IOException e) {<a name="line.615"></a>
+<span class="sourceLineNo">616</span>            // should not happen because a StringWriter does not do IO.<a name="line.616"></a>
+<span class="sourceLineNo">617</span>            throw new IllegalStateException(e);<a name="line.617"></a>
+<span class="sourceLineNo">618</span>        }<a name="line.618"></a>
+<span class="sourceLineNo">619</span>    }<a name="line.619"></a>
+<span class="sourceLineNo">620</span><a name="line.620"></a>
+<span class="sourceLineNo">621</span>    /**<a name="line.621"></a>
+<span class="sourceLineNo">622</span>     * Specifies whether missing column names are allowed when parsing the header line.<a name="line.622"></a>
+<span class="sourceLineNo">623</span>     *<a name="line.623"></a>
+<span class="sourceLineNo">624</span>     * @return {@code true} if missing column names are allowed when parsing the header line, {@code false} to throw an<a name="line.624"></a>
+<span class="sourceLineNo">625</span>     *         {@link IllegalArgumentException}.<a name="line.625"></a>
+<span class="sourceLineNo">626</span>     */<a name="line.626"></a>
+<span class="sourceLineNo">627</span>    public boolean getAllowMissingColumnNames() {<a name="line.627"></a>
+<span class="sourceLineNo">628</span>        return allowMissingColumnNames;<a name="line.628"></a>
+<span class="sourceLineNo">629</span>    }<a name="line.629"></a>
+<span class="sourceLineNo">630</span><a name="line.630"></a>
+<span class="sourceLineNo">631</span>    /**<a name="line.631"></a>
+<span class="sourceLineNo">632</span>     * Returns the character marking the start of a line comment.<a name="line.632"></a>
+<span class="sourceLineNo">633</span>     *<a name="line.633"></a>
+<span class="sourceLineNo">634</span>     * @return the comment start marker, may be {@code null}<a name="line.634"></a>
+<span class="sourceLineNo">635</span>     */<a name="line.635"></a>
+<span class="sourceLineNo">636</span>    public Character getCommentMarker() {<a name="line.636"></a>
+<span class="sourceLineNo">637</span>        return commentMarker;<a name="line.637"></a>
+<span class="sourceLineNo">638</span>    }<a name="line.638"></a>
+<span class="sourceLineNo">639</span><a name="line.639"></a>
+<span class="sourceLineNo">640</span>    /**<a name="line.640"></a>
+<span class="sourceLineNo">641</span>     * Returns the character delimiting the values (typically ';', ',' or '\t').<a name="line.641"></a>
+<span class="sourceLineNo">642</span>     *<a name="line.642"></a>
+<span class="sourceLineNo">643</span>     * @return the delimiter character<a name="line.643"></a>
+<span class="sourceLineNo">644</span>     */<a name="line.644"></a>
+<span class="sourceLineNo">645</span>    public char getDelimiter() {<a name="line.645"></a>
+<span class="sourceLineNo">646</span>        return delimiter;<a name="line.646"></a>
+<span class="sourceLineNo">647</span>    }<a name="line.647"></a>
+<span class="sourceLineNo">648</span><a name="line.648"></a>
+<span class="sourceLineNo">649</span>    /**<a name="line.649"></a>
+<span class="sourceLineNo">650</span>     * Returns the escape character.<a name="line.650"></a>
+<span class="sourceLineNo">651</span>     *<a name="line.651"></a>
+<span class="sourceLineNo">652</span>     * @return the escape character, may be {@code null}<a name="line.652"></a>
+<span class="sourceLineNo">653</span>     */<a name="line.653"></a>
+<span class="sourceLineNo">654</span>    public Character getEscapeCharacter() {<a name="line.654"></a>
+<span class="sourceLineNo">655</span>        return escapeCharacter;<a name="line.655"></a>
+<span class="sourceLineNo">656</span>    }<a name="line.656"></a>
+<span class="sourceLineNo">657</span><a name="line.657"></a>
+<span class="sourceLineNo">658</span>    /**<a name="line.658"></a>
+<span class="sourceLineNo">659</span>     * Returns a copy of the header array.<a name="line.659"></a>
+<span class="sourceLineNo">660</span>     *<a name="line.660"></a>
+<span class="sourceLineNo">661</span>     * @return a copy of the header array; {@code null} if disabled, the empty array if to be read from the file<a name="line.661"></a>
+<span class="sourceLineNo">662</span>     */<a name="line.662"></a>
+<span class="sourceLineNo">663</span>    public String[] getHeader() {<a name="line.663"></a>
+<span class="sourceLineNo">664</span>        return header != null ? header.clone() : null;<a name="line.664"></a>
+<span class="sourceLineNo">665</span>    }<a name="line.665"></a>
+<span class="sourceLineNo">666</span><a name="line.666"></a>
+<span class="sourceLineNo">667</span>    /**<a name="line.667"></a>
+<span class="sourceLineNo">668</span>     * Returns a copy of the header comment array.<a name="line.668"></a>
+<span class="sourceLineNo">669</span>     *<a name="line.669"></a>
+<span class="sourceLineNo">670</span>     * @return a copy of the header comment array; {@code null} if disabled.<a name="line.670"></a>
+<span class="sourceLineNo">671</span>     */<a name="line.671"></a>
+<span class="sourceLineNo">672</span>    public String[] getHeaderComments() {<a name="line.672"></a>
+<span class="sourceLineNo">673</span>        return headerComments != null ? headerComments.clone() : null;<a name="line.673"></a>
+<span class="sourceLineNo">674</span>    }<a name="line.674"></a>
+<span class="sourceLineNo">675</span><a name="line.675"></a>
+<span class="sourceLineNo">676</span>    /**<a name="line.676"></a>
+<span class="sourceLineNo">677</span>     * Specifies whether empty lines between records are ignored when parsing input.<a name="line.677"></a>
+<span class="sourceLineNo">678</span>     *<a name="line.678"></a>
+<span class="sourceLineNo">679</span>     * @return {@code true} if empty lines between records are ignored, {@code false} if they are turned into empty<a name="line.679"></a>
+<span class="sourceLineNo">680</span>     *         records.<a name="line.680"></a>
+<span class="sourceLineNo">681</span>     */<a name="line.681"></a>
+<span class="sourceLineNo">682</span>    public boolean getIgnoreEmptyLines() {<a name="line.682"></a>
+<span class="sourceLineNo">683</span>        return ignoreEmptyLines;<a name="line.683"></a>
+<span class="sourceLineNo">684</span>    }<a name="line.684"></a>
+<span class="sourceLineNo">685</span><a name="line.685"></a>
+<span class="sourceLineNo">686</span>    /**<a name="line.686"></a>
+<span class="sourceLineNo">687</span>     * Specifies whether header names will be accessed ignoring case.<a name="line.687"></a>
+<span class="sourceLineNo">688</span>     *<a name="line.688"></a>
+<span class="sourceLineNo">689</span>     * @return {@code true} if header names cases are ignored, {@code false} if they are case sensitive.<a name="line.689"></a>
+<span class="sourceLineNo">690</span>     * @since 1.3<a name="line.690"></a>
+<span class="sourceLineNo">691</span>     */<a name="line.691"></a>
+<span class="sourceLineNo">692</span>    public boolean getIgnoreHeaderCase() {<a name="line.692"></a>
+<span class="sourceLineNo">693</span>        return ignoreHeaderCase;<a name="line.693"></a>
+<span class="sourceLineNo">694</span>    }<a name="line.694"></a>
+<span class="sourceLineNo">695</span><a name="line.695"></a>
+<span class="sourceLineNo">696</span>    /**<a name="line.696"></a>
+<span class="sourceLineNo">697</span>     * Specifies whether spaces around values are ignored when parsing input.<a name="line.697"></a>
+<span class="sourceLineNo">698</span>     *<a name="line.698"></a>
+<span class="sourceLineNo">699</span>     * @return {@code true} if spaces around values are ignored, {@code false} if they are treated as part of the value.<a name="line.699"></a>
+<span class="sourceLineNo">700</span>     */<a name="line.700"></a>
+<span class="sourceLineNo">701</span>    public boolean getIgnoreSurroundingSpaces() {<a name="line.701"></a>
+<span class="sourceLineNo">702</span>        return ignoreSurroundingSpaces;<a name="line.702"></a>
+<span class="sourceLineNo">703</span>    }<a name="line.703"></a>
+<span class="sourceLineNo">704</span><a name="line.704"></a>
+<span class="sourceLineNo">705</span>    /**<a name="line.705"></a>
+<span class="sourceLineNo">706</span>     * Gets the String to convert to and from {@code null}.<a name="line.706"></a>
+<span class="sourceLineNo">707</span>     * &lt;ul&gt;<a name="line.707"></a>
+<span class="sourceLineNo">708</span>     * &lt;li&gt;&lt;strong&gt;Reading:&lt;/strong&gt; Converts strings equal to the given {@code nullString} to {@code null} when reading<a name="line.708"></a>
+<span class="sourceLineNo">709</span>     * records.&lt;/li&gt;<a name="line.709"></a>
+<span class="sourceLineNo">710</span>     * &lt;li&gt;&lt;strong&gt;Writing:&lt;/strong&gt; Writes {@code null} as the given {@code nullString} when writing records.&lt;/li&gt;<a name="line.710"></a>
+<span class="sourceLineNo">711</span>     * &lt;/ul&gt;<a name="line.711"></a>
+<span class="sourceLineNo">712</span>     *<a name="line.712"></a>
+<span class="sourceLineNo">713</span>     * @return the String to convert to and from {@code null}. No substitution occurs if {@code null}<a name="line.713"></a>
+<span class="sourceLineNo">714</span>     */<a name="line.714"></a>
+<span class="sourceLineNo">715</span>    public String getNullString() {<a name="line.715"></a>
+<span class="sourceLineNo">716</span>        return nullString;<a name="line.716"></a>
+<span class="sourceLineNo">717</span>    }<a name="line.717"></a>
+<span class="sourceLineNo">718</span><a name="line.718"></a>
+<span class="sourceLineNo">719</span>    /**<a name="line.719"></a>
+<span class="sourceLineNo">720</span>     * Returns the character used to encapsulate values containing special characters.<a name="line.720"></a>
+<span class="sourceLineNo">721</span>     *<a name="line.721"></a>
+<span class="sourceLineNo">722</span>     * @return the quoteChar character, may be {@code null}<a name="line.722"></a>
+<span class="sourceLineNo">723</span>     */<a name="line.723"></a>
+<span class="sourceLineNo">724</span>    public Character getQuoteCharacter() {<a name="line.724"></a>
+<span class="sourceLineNo">725</span>        return quoteCharacter;<a name="line.725"></a>
+<span class="sourceLineNo">726</span>    }<a name="line.726"></a>
+<span class="sourceLineNo">727</span><a name="line.727"></a>
+<span class="sourceLineNo">728</span>    /**<a name="line.728"></a>
+<span class="sourceLineNo">729</span>     * Returns the quote policy output fields.<a name="line.729"></a>
+<span class="sourceLineNo">730</span>     *<a name="line.730"></a>
+<span class="sourceLineNo">731</span>     * @return the quote policy<a name="line.731"></a>
+<span class="sourceLineNo">732</span>     */<a name="line.732"></a>
+<span class="sourceLineNo">733</span>    public QuoteMode getQuoteMode() {<a name="line.733"></a>
+<span class="sourceLineNo">734</span>        return quoteMode;<a name="line.734"></a>
+<span class="sourceLineNo">735</span>    }<a name="line.735"></a>
+<span class="sourceLineNo">736</span><a name="line.736"></a>
+<span class="sourceLineNo">737</span>    /**<a name="line.737"></a>
+<span class="sourceLineNo">738</span>     * Returns the record separator delimiting output records.<a name="line.738"></a>
+<span class="sourceLineNo">739</span>     *<a name="line.739"></a>
+<span class="sourceLineNo">740</span>     * @return the record separator<a name="line.740"></a>
+<span class="sourceLineNo">741</span>     */<a name="line.741"></a>
+<span class="sourceLineNo">742</span>    public String getRecordSeparator() {<a name="line.742"></a>
+<span class="sourceLineNo">743</span>        return recordSeparator;<a name="line.743"></a>
+<span class="sourceLineNo">744</span>    }<a name="line.744"></a>
+<span class="sourceLineNo">745</span><a name="line.745"></a>
+<span class="sourceLineNo">746</span>    /**<a name="line.746"></a>
+<span class="sourceLineNo">747</span>     * Returns whether to skip the header record.<a name="line.747"></a>
+<span class="sourceLineNo">748</span>     *<a name="line.748"></a>
+<span class="sourceLineNo">749</span>     * @return whether to skip the header record.<a name="line.749"></a>
+<span class="sourceLineNo">750</span>     */<a name="line.750"></a>
+<span class="sourceLineNo">751</span>    public boolean getSkipHeaderRecord() {<a name="line.751"></a>
+<span class="sourceLineNo">752</span>        return skipHeaderRecord;<a name="line.752"></a>
+<span class="sourceLineNo">753</span>    }<a name="line.753"></a>
+<span class="sourceLineNo">754</span><a name="line.754"></a>
+<span class="sourceLineNo">755</span>    /**<a name="line.755"></a>
+<span class="sourceLineNo">756</span>     * Returns whether to add a trailing delimiter.<a name="line.756"></a>
+<span class="sourceLineNo">757</span>     *<a name="line.757"></a>
+<span class="sourceLineNo">758</span>     * @return whether to add a trailing delimiter.<a name="line.758"></a>
+<span class="sourceLineNo">759</span>     * @since 1.3<a name="line.759"></a>
+<span class="sourceLineNo">760</span>     */<a name="line.760"></a>
+<span class="sourceLineNo">761</span>    public boolean getTrailingDelimiter() {<a name="line.761"></a>
+<span class="sourceLineNo">762</span>        return trailingDelimiter;<a name="line.762"></a>
+<span class="sourceLineNo">763</span>    }<a name="line.763"></a>
+<span class="sourceLineNo">764</span><a name="line.764"></a>
+<span class="sourceLineNo">765</span>    /**<a name="line.765"></a>
+<span class="sourceLineNo">766</span>     * Returns whether to trim leading and trailing blanks.<a name="line.766"></a>
+<span class="sourceLineNo">767</span>     *<a name="line.767"></a>
+<span class="sourceLineNo">768</span>     * @return whether to trim leading and trailing blanks.<a name="line.768"></a>
+<span class="sourceLineNo">769</span>     */<a name="line.769"></a>
+<span class="sourceLineNo">770</span>    public boolean getTrim() {<a name="line.770"></a>
+<span class="sourceLineNo">771</span>        return trim;<a name="line.771"></a>
+<span class="sourceLineNo">772</span>    }<a name="line.772"></a>
+<span class="sourceLineNo">773</span><a name="line.773"></a>
+<span class="sourceLineNo">774</span>    @Override<a name="line.774"></a>
+<span class="sourceLineNo">775</span>    public int hashCode() {<a name="line.775"></a>
+<span class="sourceLineNo">776</span>        final int prime = 31;<a name="line.776"></a>
+<span class="sourceLineNo">777</span>        int result = 1;<a name="line.777"></a>
+<span class="sourceLineNo">778</span><a name="line.778"></a>
+<span class="sourceLineNo">779</span>        result = prime * result + delimiter;<a name="line.779"></a>
+<span class="sourceLineNo">780</span>        result = prime * result + ((quoteMode == null) ? 0 : quoteMode.hashCode());<a name="line.780"></a>
+<span class="sourceLineNo">781</span>        result = prime * result + ((quoteCharacter == null) ? 0 : quoteCharacter.hashCode());<a name="line.781"></a>
+<span class="sourceLineNo">782</span>        result = prime * result + ((commentMarker == null) ? 0 : commentMarker.hashCode());<a name="line.782"></a>
+<span class="sourceLineNo">783</span>        result = prime * result + ((escapeCharacter == null) ? 0 : escapeCharacter.hashCode());<a name="line.783"></a>
+<span class="sourceLineNo">784</span>        result = prime * result + ((nullString == null) ? 0 : nullString.hashCode());<a name="line.784"></a>
+<span class="sourceLineNo">785</span>        result = prime * result + (ignoreSurroundingSpaces ? 1231 : 1237);<a name="line.785"></a>
+<span class="sourceLineNo">786</span>        result = prime * result + (ignoreHeaderCase ? 1231 : 1237);<a name="line.786"></a>
+<span class="sourceLineNo">787</span>        result = prime * result + (ignoreEmptyLines ? 1231 : 1237);<a name="line.787"></a>
+<span class="sourceLineNo">788</span>        result = prime * result + (skipHeaderRecord ? 1231 : 1237);<a name="line.788"></a>
+<span class="sourceLineNo">789</span>        result = prime * result + ((recordSeparator == null) ? 0 : recordSeparator.hashCode());<a name="line.789"></a>
+<span class="sourceLineNo">790</span>        result = prime * result + Arrays.hashCode(header);<a name="line.790"></a>
+<span class="sourceLineNo">791</span>        return result;<a name="line.791"></a>
+<span class="sourceLineNo">792</span>    }<a name="line.792"></a>
+<span class="sourceLineNo">793</span><a name="line.793"></a>
+<span class="sourceLineNo">794</span>    /**<a name="line.794"></a>
+<span class="sourceLineNo">795</span>     * Specifies whether comments are supported by this format.<a name="line.795"></a>
+<span class="sourceLineNo">796</span>     *<a name="line.796"></a>
+<span class="sourceLineNo">797</span>     * Note that the comment introducer character is only recognized at the start of a line.<a name="line.797"></a>
+<span class="sourceLineNo">798</span>     *<a name="line.798"></a>
+<span class="sourceLineNo">799</span>     * @return {@code true} is comments are supported, {@code false} otherwise<a name="line.799"></a>
+<span class="sourceLineNo">800</span>     */<a name="line.800"></a>
+<span class="sourceLineNo">801</span>    public boolean isCommentMarkerSet() {<a name="line.801"></a>
+<span class="sourceLineNo">802</span>        return commentMarker != null;<a name="line.802"></a>
+<span class="sourceLineNo">803</span>    }<a name="line.803"></a>
+<span class="sourceLineNo">804</span><a name="line.804"></a>
+<span class="sourceLineNo">805</span>    /**<a name="line.805"></a>
+<span class="sourceLineNo">806</span>     * Returns whether escape are being processed.<a name="line.806"></a>
+<span class="sourceLineNo">807</span>     *<a name="line.807"></a>
+<span class="sourceLineNo">808</span>     * @return {@code true} if escapes are processed<a name="line.808"></a>
+<span class="sourceLineNo">809</span>     */<a name="line.809"></a>
+<span class="sourceLineNo">810</span>    public boolean isEscapeCharacterSet() {<a name="line.810"></a>
+<span class="sourceLineNo">811</span>        return escapeCharacter != null;<a name="line.811"></a>
+<span class="sourceLineNo">812</span>    }<a name="line.812"></a>
+<span class="sourceLineNo">813</span><a name="line.813"></a>
+<span class="sourceLineNo">814</span>    /**<a name="line.814"></a>
+<span class="sourceLineNo">815</span>     * Returns whether a nullString has been defined.<a name="line.815"></a>
+<span class="sourceLineNo">816</span>     *<a name="line.816"></a>
+<span class="sourceLineNo">817</span>     * @return {@code true} if a nullString is defined<a name="line.817"></a>
+<span class="sourceLineNo">818</span>     */<a name="line.818"></a>
+<span class="sourceLineNo">819</span>    public boolean isNullStringSet() {<a name="line.819"></a>
+<span class="sourceLineNo">820</span>        return nullString != null;<a name="line.820"></a>
+<span class="sourceLineNo">821</span>    }<a name="line.821"></a>
+<span class="sourceLineNo">822</span><a name="line.822"></a>
+<span class="sourceLineNo">823</span>    /**<a name="line.823"></a>
+<span class="sourceLineNo">824</span>     * Returns whether a quoteChar has been defined.<a name="line.824"></a>
+<span class="sourceLineNo">825</span>     *<a name="line.825"></a>
+<span class="sourceLineNo">826</span>     * @return {@code true} if a quoteChar is defined<a name="line.826"></a>
+<span class="sourceLineNo">827</span>     */<a name="line.827"></a>
+<span class="sourceLineNo">828</span>    public boolean isQuoteCharacterSet() {<a name="line.828"></a>
+<span class="sourceLineNo">829</span>        return quoteCharacter != null;<a name="line.829"></a>
+<span class="sourceLineNo">830</span>    }<a name="line.830"></a>
+<span class="sourceLineNo">831</span><a name="line.831"></a>
+<span class="sourceLineNo">832</span>    /**<a name="line.832"></a>
+<span class="sourceLineNo">833</span>     * Parses the specified content.<a name="line.833"></a>
+<span class="sourceLineNo">834</span>     *<a name="line.834"></a>
+<span class="sourceLineNo">835</span>     * &lt;p&gt;<a name="line.835"></a>
+<span class="sourceLineNo">836</span>     * See also the various static parse methods on {@link CSVParser}.<a name="line.836"></a>
+<span class="sourceLineNo">837</span>     * &lt;/p&gt;<a name="line.837"></a>
+<span class="sourceLineNo">838</span>     *<a name="line.838"></a>
+<span class="sourceLineNo">839</span>     * @param in<a name="line.839"></a>
+<span class="sourceLineNo">840</span>     *            the input stream<a name="line.840"></a>
+<span class="sourceLineNo">841</span>     * @return a parser over a stream of {@link CSVRecord}s.<a name="line.841"></a>
+<span class="sourceLineNo">842</span>     * @throws IOException<a name="line.842"></a>
+<span class="sourceLineNo">843</span>     *             If an I/O error occurs<a name="line.843"></a>
+<span class="sourceLineNo">844</span>     */<a name="line.844"></a>
+<span class="sourceLineNo">845</span>    public CSVParser parse(final Reader in) throws IOException {<a name="line.845"></a>
+<span class="sourceLineNo">846</span>        return new CSVParser(in, this);<a name="line.846"></a>
+<span class="sourceLineNo">847</span>    }<a name="line.847"></a>
+<span class="sourceLineNo">848</span><a name="line.848"></a>
+<span class="sourceLineNo">849</span>    /**<a name="line.849"></a>
+<span class="sourceLineNo">850</span>     * Prints to the specified output.<a name="line.850"></a>
+<span class="sourceLineNo">851</span>     *<a name="line.851"></a>
+<span class="sourceLineNo">852</span>     * &lt;p&gt;<a name="line.852"></a>
+<span class="sourceLineNo">853</span>     * See also {@link CSVPrinter}.<a name="line.853"></a>
+<span class="sourceLineNo">854</span>     * &lt;/p&gt;<a name="line.854"></a>
+<span class="sourceLineNo">855</span>     *<a name="line.855"></a>
+<span class="sourceLineNo">856</span>     * @param out<a name="line.856"></a>
+<span class="sourceLineNo">857</span>     *            the output<a name="line.857"></a>
+<span class="sourceLineNo">858</span>     * @return a printer to an output<a name="line.858"></a>
+<span class="sourceLineNo">859</span>     * @throws IOException<a name="line.859"></a>
+<span class="sourceLineNo">860</span>     *             thrown if the optional header cannot be printed.<a name="line.860"></a>
+<span class="sourceLineNo">861</span>     */<a name="line.861"></a>
+<span class="sourceLineNo">862</span>    public CSVPrinter print(final Appendable out) throws IOException {<a name="line.862"></a>
+<span class="sourceLineNo">863</span>        return new CSVPrinter(out, this);<a name="line.863"></a>
+<span class="sourceLineNo">864</span>    }<a name="line.864"></a>
+<span class="sourceLineNo">865</span><a name="line.865"></a>
+<span class="sourceLineNo">866</span>    /**<a name="line.866"></a>
+<span class="sourceLineNo">867</span>     * Prints the {@code value} as the next value on the line to {@code out}. The value will be escaped or encapsulated<a name="line.867"></a>
+<span class="sourceLineNo">868</span>     * as needed. Useful when one wants to avoid creating CSVPrinters.<a name="line.868"></a>
+<span class="sourceLineNo">869</span>     *<a name="line.869"></a>
+<span class="sourceLineNo">870</span>     * @param value<a name="line.870"></a>
+<span class="sourceLineNo">871</span>     *            value to output.<a name="line.871"></a>
+<span class="sourceLineNo">872</span>     * @param out<a name="line.872"></a>
+<span class="sourceLineNo">873</span>     *            where to print the value<a name="line.873"></a>
+<span class="sourceLineNo">874</span>     * @param newRecord<a name="line.874"></a>
+<span class="sourceLineNo">875</span>     *            if this a new record<a name="line.875"></a>
+<span class="sourceLineNo">876</span>     * @throws IOException<a name="line.876"></a>
+<span class="sourceLineNo">877</span>     *             If an I/O error occurs<a name="line.877"></a>
+<span class="sourceLineNo">878</span>     * @since 1.4<a name="line.878"></a>
+<span class="sourceLineNo">879</span>     */<a name="line.879"></a>
+<span class="sourceLineNo">880</span>    public void print(final Object value, final Appendable out, final boolean newRecord) throws IOException {<a name="line.880"></a>
+<span class="sourceLineNo">881</span>        // null values are considered empty<a name="line.881"></a>
+<span class="sourceLineNo">882</span>        // Only call CharSequence.toString() if you have to, helps GC-free use cases.<a name="line.882"></a>
+<span class="sourceLineNo">883</span>        CharSequence charSequence;<a name="line.883"></a>
+<span class="sourceLineNo">884</span>        if (value == null) {<a name="line.884"></a>
+<span class="sourceLineNo">885</span>            charSequence = nullString == null ? Constants.EMPTY : nullString;<a name="line.885"></a>
+<span class="sourceLineNo">886</span>        } else {<a name="line.886"></a>
+<span class="sourceLineNo">887</span>            charSequence = value instanceof CharSequence ? (CharSequence) value : value.toString();<a name="line.887"></a>
+<span class="sourceLineNo">888</span>        }<a name="line.888"></a>
+<span class="sourceLineNo">889</span>        charSequence = getTrim() ? trim(charSequence) : charSequence;<a name="line.889"></a>
+<span class="sourceLineNo">890</span>        this.print(value, charSequence, 0, charSequence.length(), out, newRecord);<a name="line.890"></a>
+<span class="sourceLineNo">891</span>    }<a name="line.891"></a>
+<span class="sourceLineNo">892</span><a name="line.892"></a>
+<span class="sourceLineNo">893</span>    private void print(final Object object, final CharSequence value, final int offset, final int len,<a name="line.893"></a>
+<span class="sourceLineNo">894</span>            final Appendable out, final boolean newRecord) throws IOException {<a name="line.894"></a>
+<span class="sourceLineNo">895</span>        if (!newRecord) {<a name="line.895"></a>
+<span class="sourceLineNo">896</span>            out.append(getDelimiter());<a name="line.896"></a>
+<span class="sourceLineNo">897</span>        }<a name="line.897"></a>
+<span class="sourceLineNo">898</span>        if (object == null) {<a name="line.898"></a>
+<span class="sourceLineNo">899</span>            out.append(value);<a name="line.899"></a>
+<span class="sourceLineNo">900</span>        } else if (isQuoteCharacterSet()) {<a name="line.900"></a>
+<span class="sourceLineNo">901</span>            // the original object is needed so can check for Number<a name="line.901"></a>
+<span class="sourceLineNo">902</span>            printAndQuote(object, value, offset, len, out, newRecord);<a name="line.902"></a>
+<span class="sourceLineNo">903</span>        } else if (isEscapeCharacterSet()) {<a name="line.903"></a>
+<span class="sourceLineNo">904</span>            printAndEscape(value, offset, len, out);<a name="line.904"></a>
+<span class="sourceLineNo">905</span>        } else {<a name="line.905"></a>
+<span class="sourceLineNo">906</span>            out.append(value, offset, offset + len);<a name="line.906"></a>
+<span class="sourceLineNo">907</span>        }<a name="line.907"></a>
+<span class="sourceLineNo">908</span>    }<a name="line.908"></a>
+<span class="sourceLineNo">909</span><a name="line.909"></a>
+<span class="sourceLineNo">910</span>    /*<a name="line.910"></a>
+<span class="sourceLineNo">911</span>     * Note: must only be called if escaping is enabled, otherwise will generate NPE<a name="line.911"></a>
+<span class="sourceLineNo">912</span>     */<a name="line.912"></a>
+<span class="sourceLineNo">913</span>    private void printAndEscape(final CharSequence value, final int offset, final int len, final Appendable out)<a name="line.913"></a>
+<span class="sourceLineNo">914</span>            throws IOException {<a name="line.914"></a>
+<span class="sourceLineNo">915</span>        int start = offset;<a name="line.915"></a>
+<span class="sourceLineNo">916</span>        int pos = offset;<a name="line.916"></a>
+<span class="sourceLineNo">917</span>        final int end = offset + len;<a name="line.917"></a>
+<span class="sourceLineNo">918</span><a name="line.918"></a>
+<span class="sourceLineNo">919</span>        final char delim = getDelimiter();<a name="line.919"></a>
+<span class="sourceLineNo">920</span>        final char escape = getEscapeCharacter().charValue();<a name="line.920"></a>
+<span class="sourceLineNo">921</span><a name="line.921"></a>
+<span class="sourceLineNo">922</span>        while (pos &lt; end) {<a name="line.922"></a>
+<span class="sourceLineNo">923</span>            char c = value.charAt(pos);<a name="line.923"></a>
+<span class="sourceLineNo">924</span>            if (c == CR || c == LF || c == delim || c == escape) {<a name="line.924"></a>
+<span class="sourceLineNo">925</span>                // write out segment up until this char<a name="line.925"></a>
+<span class="sourceLineNo">926</span>                if (pos &gt; start) {<a name="line.926"></a>
+<span class="sourceLineNo">927</span>                    out.append(value, start, pos);<a name="line.927"></a>
+<span class="sourceLineNo">928</span>                }<a name="line.928"></a>
+<span class="sourceLineNo">929</span>                if (c == LF) {<a name="line.929"></a>
+<span class="sourceLineNo">930</span>                    c = 'n';<a name="line.930"></a>
+<span class="sourceLineNo">931</span>                } else if (c == CR) {<a name="line.931"></a>
+<span class="sourceLineNo">932</span>                    c = 'r';<a name="line.932"></a>
+<span class="sourceLineNo">933</span>                }<a name="line.933"></a>
+<span class="sourceLineNo">934</span><a name="line.934"></a>
+<span class="sourceLineNo">935</span>                out.append(escape);<a name="line.935"></a>
+<span class="sourceLineNo">936</span>                out.append(c);<a name="line.936"></a>
+<span class="sourceLineNo">937</span><a name="line.937"></a>

[... 896 lines stripped ...]



Mime
View raw message