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