Added: websites/production/commons/content/proper/commons-csv/archives/1.6/jacoco/org.apache.commons.csv/CSVFormat.java.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/archives/1.6/jacoco/org.apache.commons.csv/CSVFormat.java.html (added) +++ websites/production/commons/content/proper/commons-csv/archives/1.6/jacoco/org.apache.commons.csv/CSVFormat.java.html Tue Sep 25 13:26:18 2018 @@ -0,0 +1,2043 @@ +<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";><html xmlns="http://www.w3.org/1999/xhtml"; lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>CSVFormat.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Commons CSV</a> > <a href="index.source.html" class="el_package">org.apache.commons.csv</a> > <span class="el_source">CSVFormat.ja va</span></div><h1>CSVFormat.java</h1><pre class="source lang-java linenums">/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.csv.Constants.BACKSLASH; +import static org.apache.commons.csv.Constants.COMMA; +import static org.apache.commons.csv.Constants.COMMENT; +import static org.apache.commons.csv.Constants.EMPTY; +import static org.apache.commons.csv.Constants.CR; +import static org.apache.commons.csv.Constants.CRLF; +import static org.apache.commons.csv.Constants.DOUBLE_QUOTE_CHAR; +import static org.apache.commons.csv.Constants.LF; +import static org.apache.commons.csv.Constants.PIPE; +import static org.apache.commons.csv.Constants.SP; +import static org.apache.commons.csv.Constants.TAB; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.io.Reader; +import java.io.Serializable; +import java.io.StringWriter; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.sql.ResultSet; +import java.sql.ResultSetMetaData; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.HashSet; +import java.util.Set; + +/** + * Specifies the format of a CSV file and parses input. + * + * <h2>Using predefined formats</h2> + * + * <p> + * You can use one of the predefined formats: + * </p> + * + * <ul> + * <li>{@link #DEFAULT}</li> + * <li>{@link #EXCEL}</li> + * <li>{@link #INFORMIX_UNLOAD}</li> + * <li>{@link #INFORMIX_UNLOAD_CSV}</li> + * <li>{@link #MYSQL}</li> + * <li>{@link #RFC4180}</li> + * <li>{@link #ORACLE}</li> + * <li>{@link #POSTGRESQL_CSV}</li> + * <li>{@link #POSTGRESQL_TEXT}</li> + * <li>{@link #TDF}</li> + * </ul> + * + * <p> + * For example: + * </p> + * + * <pre> + * CSVParser parser = CSVFormat.EXCEL.parse(reader); + * </pre> + * + * <p> + * The {@link CSVParser} provides static methods to parse other input types, for example: + * </p> + * + * <pre> + * CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL); + * </pre> + * + * <h2>Defining formats</h2> + * + * <p> + * You can extend a format by calling the {@code with} methods. For example: + * </p> + * + * <pre> + * CSVFormat.EXCEL.withNullString(&quot;N/A&quot;).withIgnoreSurroundingSpaces(true); + * </pre> + * + * <h2>Defining column names</h2> + * + * <p> + * To define the column names you want to use to access records, write: + * </p> + * + * <pre> + * CSVFormat.EXCEL.withHeader(&quot;Col1&quot;, &quot;Col2&quot;, &quot;Col3&quot;); + * </pre> + * + * <p> + * Calling {@link #withHeader(String...)} let's you use the given names to address values in a {@link CSVRecord}, and + * assumes that your CSV source does not contain a first record that also defines column names. + * + * If it does, then you are overriding this metadata with your names and you should skip the first record by calling + * {@link #withSkipHeaderRecord(boolean)} with {@code true}. + * </p> + * + * <h2>Parsing</h2> + * + * <p> + * You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write: + * </p> + * + * <pre> + * Reader in = ...; + * CSVFormat.EXCEL.withHeader(&quot;Col1&quot;, &quot;Col2&quot;, &quot;Col3&quot;).parse(in); + * </pre> + * + * <p> + * For other input types, like resources, files, and URLs, use the static methods on {@link CSVParser}. + * </p> + * + * <h2>Referencing columns safely</h2> + * + * <p> + * If your source contains a header record, you can simplify your code and safely reference columns, by using + * {@link #withHeader(String...)} with no arguments: + * </p> + * + * <pre> + * CSVFormat.EXCEL.withHeader(); + * </pre> + * + * <p> + * This causes the parser to read the first record and use its values as column names. + * + * Then, call one of the {@link CSVRecord} get method that takes a String column name argument: + * </p> + * + * <pre> + * String value = record.get(&quot;Col1&quot;); + * </pre> + * + * <p> + * This makes your code impervious to changes in column order in the CSV file. + * </p> + * + * <h2>Notes</h2> + * + * <p> + * This class is immutable. + * </p> + */ +public final class CSVFormat implements Serializable { + + /** + * Predefines formats. + * + * @since 1.2 + */ +<span class="fc" id="L168"> public enum Predefined {</span> + + /** + * @see CSVFormat#DEFAULT + */ +<span class="fc" id="L173"> Default(CSVFormat.DEFAULT),</span> + + /** + * @see CSVFormat#EXCEL + */ +<span class="fc" id="L178"> Excel(CSVFormat.EXCEL),</span> + + /** + * @see CSVFormat#INFORMIX_UNLOAD + * @since 1.3 + */ +<span class="fc" id="L184"> InformixUnload(CSVFormat.INFORMIX_UNLOAD),</span> + + /** + * @see CSVFormat#INFORMIX_UNLOAD_CSV + * @since 1.3 + */ +<span class="fc" id="L190"> InformixUnloadCsv(CSVFormat.INFORMIX_UNLOAD_CSV),</span> + + /** + * @see CSVFormat#MYSQL + */ +<span class="fc" id="L195"> MySQL(CSVFormat.MYSQL),</span> + + /** + * @see CSVFormat#ORACLE + */ +<span class="fc" id="L200"> Oracle(CSVFormat.ORACLE),</span> + + /** + * @see CSVFormat#POSTGRESQL_CSV + * @since 1.5 + */ +<span class="fc" id="L206"> PostgreSQLCsv(CSVFormat.POSTGRESQL_CSV),</span> + + /** + * @see CSVFormat#POSTGRESQL_CSV + */ +<span class="fc" id="L211"> PostgreSQLText(CSVFormat.POSTGRESQL_TEXT),</span> + + /** + * @see CSVFormat#RFC4180 + */ +<span class="fc" id="L216"> RFC4180(CSVFormat.RFC4180),</span> + + /** + * @see CSVFormat#TDF + */ +<span class="fc" id="L221"> TDF(CSVFormat.TDF);</span> + + private final CSVFormat format; + +<span class="fc" id="L225"> Predefined(final CSVFormat format) {</span> +<span class="fc" id="L226"> this.format = format;</span> +<span class="fc" id="L227"> }</span> + + /** + * Gets the format. + * + * @return the format. + */ + public CSVFormat getFormat() { +<span class="fc" id="L235"> return format;</span> + } + } + + /** + * Standard Comma Separated Value format, as for {@link #RFC4180} but allowing empty lines. + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',')</li> + * <li>withQuote('"')</li> + * <li>withRecordSeparator("\r\n")</li> + * <li>withIgnoreEmptyLines(true)</li> + * </ul> + * + * @see Predefined#Default + */ +<span class="fc" id="L254"> public static final CSVFormat DEFAULT = new CSVFormat(COMMA, DOUBLE_QUOTE_CHAR, null, null, null, false, true, CRLF,</span> + null, null, null, false, false, false, false, false, false); + + /** + * Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is + * locale dependent, it might be necessary to customize this format to accommodate to your regional settings. + * + * <p> + * For example for parsing or generating a CSV file on a French system the following format will be used: + * </p> + * + * <pre> + * CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';'); + * </pre> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>{@link #withDelimiter(char) withDelimiter(',')}</li> + * <li>{@link #withQuote(char) withQuote('"')}</li> + * <li>{@link #withRecordSeparator(String) withRecordSeparator("\r\n")}</li> + * <li>{@link #withIgnoreEmptyLines(boolean) withIgnoreEmptyLines(false)}</li> + * <li>{@link #withAllowMissingColumnNames(boolean) withAllowMissingColumnNames(true)}</li> + * </ul> + * <p> + * Note: This is currently like {@link #RFC4180} plus {@link #withAllowMissingColumnNames(boolean) + * withAllowMissingColumnNames(true)} and {@link #withIgnoreEmptyLines(boolean) withIgnoreEmptyLines(false)}. + * </p> + * + * @see Predefined#Excel + */ + // @formatter:off +<span class="fc" id="L287"> public static final CSVFormat EXCEL = DEFAULT</span> +<span class="fc" id="L288"> .withIgnoreEmptyLines(false)</span> +<span class="fc" id="L289"> .withAllowMissingColumnNames();</span> + // @formatter:on + + /** + * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation. + * + * <p> + * This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special + * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',')</li> + * <li>withQuote("\"")</li> + * <li>withRecordSeparator('\n')</li> + * <li>withEscape('\\')</li> + * </ul> + * + * @see Predefined#MySQL + * @see <a href= + * "http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm"> + * http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a> + * @since 1.3 + */ + // @formatter:off +<span class="fc" id="L317"> public static final CSVFormat INFORMIX_UNLOAD = DEFAULT</span> +<span class="fc" id="L318"> .withDelimiter(PIPE)</span> +<span class="fc" id="L319"> .withEscape(BACKSLASH)</span> +<span class="fc" id="L320"> .withQuote(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L321"> .withRecordSeparator(LF);</span> + // @formatter:on + + /** + * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation (escaping is disabled.) + * + * <p> + * This is a comma-delimited format with a LF character as the line separator. Values are not quoted and special + * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',')</li> + * <li>withQuote("\"")</li> + * <li>withRecordSeparator('\n')</li> + * </ul> + * + * @see Predefined#MySQL + * @see <a href= + * "http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm"> + * http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm</a> + * @since 1.3 + */ + // @formatter:off +<span class="fc" id="L348"> public static final CSVFormat INFORMIX_UNLOAD_CSV = DEFAULT</span> +<span class="fc" id="L349"> .withDelimiter(COMMA)</span> +<span class="fc" id="L350"> .withQuote(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L351"> .withRecordSeparator(LF);</span> + // @formatter:on + + /** + * Default MySQL format used by the {@code SELECT INTO OUTFILE} and {@code LOAD DATA INFILE} operations. + * + * <p> + * This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special + * characters are escaped with {@code '\'}. The default NULL string is {@code "\\N"}. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter('\t')</li> + * <li>withQuote(null)</li> + * <li>withRecordSeparator('\n')</li> + * <li>withIgnoreEmptyLines(false)</li> + * <li>withEscape('\\')</li> + * <li>withNullString("\\N")</li> + * <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</li> + * </ul> + * + * @see Predefined#MySQL + * @see <a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html"> http://dev.mysql.com/doc/refman/5.1/en/load + * -data.html</a> + */ + // @formatter:off +<span class="fc" id="L380"> public static final CSVFormat MYSQL = DEFAULT</span> +<span class="fc" id="L381"> .withDelimiter(TAB)</span> +<span class="fc" id="L382"> .withEscape(BACKSLASH)</span> +<span class="fc" id="L383"> .withIgnoreEmptyLines(false)</span> +<span class="fc" id="L384"> .withQuote(null)</span> +<span class="fc" id="L385"> .withRecordSeparator(LF)</span> +<span class="fc" id="L386"> .withNullString("\\N")</span> +<span class="fc" id="L387"> .withQuoteMode(QuoteMode.ALL_NON_NULL);</span> + // @formatter:off + + /** + * Default Oracle format used by the SQL*Loader utility. + * + * <p> + * This is a comma-delimited format with the system line separator character as the record separator.Values are + * double quoted when needed and special characters are escaped with {@code '"'}. The default NULL string is + * {@code ""}. Values are trimmed. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',') // default is {@code FIELDS TERMINATED BY ','}</li> + * <li>withQuote('"') // default is {@code OPTIONALLY ENCLOSED BY '"'}</li> + * <li>withSystemRecordSeparator()</li> + * <li>withTrim()</li> + * <li>withIgnoreEmptyLines(false)</li> + * <li>withEscape('\\')</li> + * <li>withNullString("\\N")</li> + * <li>withQuoteMode(QuoteMode.MINIMAL)</li> + * </ul> + * + * @see Predefined#Oracle + * @see <a href="https://s.apache.org/CGXG">Oracle CSV Format Specification</a> + * @since 1.6 + */ + // @formatter:off +<span class="fc" id="L418"> public static final CSVFormat ORACLE = DEFAULT</span> +<span class="fc" id="L419"> .withDelimiter(COMMA)</span> +<span class="fc" id="L420"> .withEscape(BACKSLASH)</span> +<span class="fc" id="L421"> .withIgnoreEmptyLines(false)</span> +<span class="fc" id="L422"> .withQuote(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L423"> .withNullString("\\N")</span> +<span class="fc" id="L424"> .withTrim()</span> +<span class="fc" id="L425"> .withSystemRecordSeparator()</span> +<span class="fc" id="L426"> .withQuoteMode(QuoteMode.MINIMAL);</span> + // @formatter:off + + /** + * Default PostgreSQL CSV format used by the {@code COPY} operation. + * + * <p> + * This is a comma-delimited format with a LF character as the line separator. Values are double quoted and special + * characters are escaped with {@code '"'}. The default NULL string is {@code ""}. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',')</li> + * <li>withQuote('"')</li> + * <li>withRecordSeparator('\n')</li> + * <li>withIgnoreEmptyLines(false)</li> + * <li>withEscape('\\')</li> + * <li>withNullString("")</li> + * <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</li> + * </ul> + * + * @see Predefined#MySQL + * @see <a href="https://www.postgresql.org/docs/current/static/sql-copy.html">PostgreSQL COPY command + * documentation</a> + * @since 1.5 + */ + // @formatter:off +<span class="fc" id="L456"> public static final CSVFormat POSTGRESQL_CSV = DEFAULT</span> +<span class="fc" id="L457"> .withDelimiter(COMMA)</span> +<span class="fc" id="L458"> .withEscape(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L459"> .withIgnoreEmptyLines(false)</span> +<span class="fc" id="L460"> .withQuote(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L461"> .withRecordSeparator(LF)</span> +<span class="fc" id="L462"> .withNullString(EMPTY)</span> +<span class="fc" id="L463"> .withQuoteMode(QuoteMode.ALL_NON_NULL);</span> + // @formatter:off + + /** + * Default PostgreSQL text format used by the {@code COPY} operation. + * + * <p> + * This is a tab-delimited format with a LF character as the line separator. Values are double quoted and special + * characters are escaped with {@code '"'}. The default NULL string is {@code "\\N"}. + * </p> + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter('\t')</li> + * <li>withQuote('"')</li> + * <li>withRecordSeparator('\n')</li> + * <li>withIgnoreEmptyLines(false)</li> + * <li>withEscape('\\')</li> + * <li>withNullString("\\N")</li> + * <li>withQuoteMode(QuoteMode.ALL_NON_NULL)</li> + * </ul> + * + * @see Predefined#MySQL + * @see <a href="https://www.postgresql.org/docs/current/static/sql-copy.html">PostgreSQL COPY command + * documentation</a> + * @since 1.5 + */ + // @formatter:off +<span class="fc" id="L493"> public static final CSVFormat POSTGRESQL_TEXT = DEFAULT</span> +<span class="fc" id="L494"> .withDelimiter(TAB)</span> +<span class="fc" id="L495"> .withEscape(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L496"> .withIgnoreEmptyLines(false)</span> +<span class="fc" id="L497"> .withQuote(DOUBLE_QUOTE_CHAR)</span> +<span class="fc" id="L498"> .withRecordSeparator(LF)</span> +<span class="fc" id="L499"> .withNullString("\\N")</span> +<span class="fc" id="L500"> .withQuoteMode(QuoteMode.ALL_NON_NULL);</span> + // @formatter:off + + /** + * Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter(',')</li> + * <li>withQuote('"')</li> + * <li>withRecordSeparator("\r\n")</li> + * <li>withIgnoreEmptyLines(false)</li> + * </ul> + * + * @see Predefined#RFC4180 + */ +<span class="fc" id="L518"> public static final CSVFormat RFC4180 = DEFAULT.withIgnoreEmptyLines(false);</span> + + private static final long serialVersionUID = 1L; + + /** + * Tab-delimited format. + * + * <p> + * Settings are: + * </p> + * <ul> + * <li>withDelimiter('\t')</li> + * <li>withQuote('"')</li> + * <li>withRecordSeparator("\r\n")</li> + * <li>withIgnoreSurroundingSpaces(true)</li> + * </ul> + * + * @see Predefined#TDF + */ + // @formatter:off +<span class="fc" id="L538"> public static final CSVFormat TDF = DEFAULT</span> +<span class="fc" id="L539"> .withDelimiter(TAB)</span> +<span class="fc" id="L540"> .withIgnoreSurroundingSpaces();</span> + // @formatter:on + + /** + * Returns true if the given character is a line break character. + * + * @param c + * the character to check + * + * @return true if <code>c</code> is a line break character + */ + private static boolean isLineBreak(final char c) { +<span class="fc bfc" id="L552" title="All 4 branches covered."> return c == LF || c == CR;</span> + } + + /** + * Returns true if the given character is a line break character. + * + * @param c + * the character to check, may be null + * + * @return true if <code>c</code> is a line break character (and not null) + */ + private static boolean isLineBreak(final Character c) { +<span class="fc bfc" id="L564" title="All 4 branches covered."> return c != null && isLineBreak(c.charValue());</span> + } + + /** + * Creates a new CSV format with the specified delimiter. + * + * <p> + * Use this method if you want to create a CSVFormat from scratch. All fields but the delimiter will be initialized + * with null/false. + * </p> + * + * @param delimiter + * the char used for value separation, must not be a line break character + * @return a new CSV format. + * @throws IllegalArgumentException + * if the delimiter is a line break character + * + * @see #DEFAULT + * @see #RFC4180 + * @see #MYSQL + * @see #EXCEL + * @see #TDF + */ + public static CSVFormat newFormat(final char delimiter) { +<span class="fc" id="L588"> return new CSVFormat(delimiter, null, null, null, null, false, false, null, null, null, null, false, false,</span> + false, false, false, false); + } + + /** + * Gets one of the predefined formats from {@link CSVFormat.Predefined}. + * + * @param format + * name + * @return one of the predefined formats + * @since 1.2 + */ + public static CSVFormat valueOf(final String format) { +<span class="fc" id="L601"> return CSVFormat.Predefined.valueOf(format).getFormat();</span> + } + + private final boolean allowMissingColumnNames; + + private final Character commentMarker; // null if commenting is disabled + + private final char delimiter; + + private final Character escapeCharacter; // null if escaping is disabled + + private final String[] header; // array of header column names + + private final String[] headerComments; // array of header comment lines + + private final boolean ignoreEmptyLines; + + private final boolean ignoreHeaderCase; // should ignore header names case + + private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values? + + private final String nullString; // the string to be used for null values + + private final Character quoteCharacter; // null if quoting is disabled + + private final QuoteMode quoteMode; + + private final String recordSeparator; // for outputs + + private final boolean skipHeaderRecord; + + private final boolean trailingDelimiter; + + private final boolean trim; + + private final boolean autoFlush; + + /** + * Creates a customized CSV format. + * + * @param delimiter + * the char used for value separation, must not be a line break character + * @param quoteChar + * the Character used as value encapsulation marker, may be {@code null} to disable + * @param quoteMode + * the quote mode + * @param commentStart + * the Character used for comment identification, may be {@code null} to disable + * @param escape + * the Character used to escape special characters in values, may be {@code null} to disable + * @param ignoreSurroundingSpaces + * {@code true} when whitespaces enclosing values should be ignored + * @param ignoreEmptyLines + * {@code true} when the parser should skip empty lines + * @param recordSeparator + * the line separator to use for output + * @param nullString + * the line separator to use for output + * @param headerComments + * the comments to be printed by the Printer before the actual CSV data + * @param header + * the header + * @param skipHeaderRecord + * TODO + * @param allowMissingColumnNames + * TODO + * @param ignoreHeaderCase + * TODO + * @param trim + * TODO + * @param trailingDelimiter + * TODO + * @param autoFlush + * @throws IllegalArgumentException + * if the delimiter is a line break character + */ + private CSVFormat(final char delimiter, final Character quoteChar, final QuoteMode quoteMode, + final Character commentStart, final Character escape, final boolean ignoreSurroundingSpaces, + final boolean ignoreEmptyLines, final String recordSeparator, final String nullString, + final Object[] headerComments, final String[] header, final boolean skipHeaderRecord, + final boolean allowMissingColumnNames, final boolean ignoreHeaderCase, final boolean trim, +<span class="fc" id="L682"> final boolean trailingDelimiter, final boolean autoFlush) {</span> +<span class="fc" id="L683"> this.delimiter = delimiter;</span> +<span class="fc" id="L684"> this.quoteCharacter = quoteChar;</span> +<span class="fc" id="L685"> this.quoteMode = quoteMode;</span> +<span class="fc" id="L686"> this.commentMarker = commentStart;</span> +<span class="fc" id="L687"> this.escapeCharacter = escape;</span> +<span class="fc" id="L688"> this.ignoreSurroundingSpaces = ignoreSurroundingSpaces;</span> +<span class="fc" id="L689"> this.allowMissingColumnNames = allowMissingColumnNames;</span> +<span class="fc" id="L690"> this.ignoreEmptyLines = ignoreEmptyLines;</span> +<span class="fc" id="L691"> this.recordSeparator = recordSeparator;</span> +<span class="fc" id="L692"> this.nullString = nullString;</span> +<span class="fc" id="L693"> this.headerComments = toStringArray(headerComments);</span> +<span class="fc bfc" id="L694" title="All 2 branches covered."> this.header = header == null ? null : header.clone();</span> +<span class="fc" id="L695"> this.skipHeaderRecord = skipHeaderRecord;</span> +<span class="fc" id="L696"> this.ignoreHeaderCase = ignoreHeaderCase;</span> +<span class="fc" id="L697"> this.trailingDelimiter = trailingDelimiter;</span> +<span class="fc" id="L698"> this.trim = trim;</span> +<span class="fc" id="L699"> this.autoFlush = autoFlush;</span> +<span class="fc" id="L700"> validate();</span> +<span class="fc" id="L701"> }</span> + + @Override + public boolean equals(final Object obj) { +<span class="fc bfc" id="L705" title="All 2 branches covered."> if (this == obj) {</span> +<span class="fc" id="L706"> return true;</span> + } +<span class="fc bfc" id="L708" title="All 2 branches covered."> if (obj == null) {</span> +<span class="fc" id="L709"> return false;</span> + } +<span class="fc bfc" id="L711" title="All 2 branches covered."> if (getClass() != obj.getClass()) {</span> +<span class="fc" id="L712"> return false;</span> + } + +<span class="fc" id="L715"> final CSVFormat other = (CSVFormat) obj;</span> +<span class="fc bfc" id="L716" title="All 2 branches covered."> if (delimiter != other.delimiter) {</span> +<span class="fc" id="L717"> return false;</span> + } +<span class="fc bfc" id="L719" title="All 2 branches covered."> if (quoteMode != other.quoteMode) {</span> +<span class="fc" id="L720"> return false;</span> + } +<span class="fc bfc" id="L722" title="All 2 branches covered."> if (quoteCharacter == null) {</span> +<span class="fc bfc" id="L723" title="All 2 branches covered."> if (other.quoteCharacter != null) {</span> +<span class="fc" id="L724"> return false;</span> + } +<span class="fc bfc" id="L726" title="All 2 branches covered."> } else if (!quoteCharacter.equals(other.quoteCharacter)) {</span> +<span class="fc" id="L727"> return false;</span> + } +<span class="fc bfc" id="L729" title="All 2 branches covered."> if (commentMarker == null) {</span> +<span class="fc bfc" id="L730" title="All 2 branches covered."> if (other.commentMarker != null) {</span> +<span class="fc" id="L731"> return false;</span> + } +<span class="fc bfc" id="L733" title="All 2 branches covered."> } else if (!commentMarker.equals(other.commentMarker)) {</span> +<span class="fc" id="L734"> return false;</span> + } +<span class="fc bfc" id="L736" title="All 2 branches covered."> if (escapeCharacter == null) {</span> +<span class="pc bpc" id="L737" title="1 of 2 branches missed."> if (other.escapeCharacter != null) {</span> +<span class="nc" id="L738"> return false;</span> + } +<span class="fc bfc" id="L740" title="All 2 branches covered."> } else if (!escapeCharacter.equals(other.escapeCharacter)) {</span> +<span class="fc" id="L741"> return false;</span> + } +<span class="fc bfc" id="L743" title="All 2 branches covered."> if (nullString == null) {</span> +<span class="pc bpc" id="L744" title="1 of 2 branches missed."> if (other.nullString != null) {</span> +<span class="nc" id="L745"> return false;</span> + } +<span class="fc bfc" id="L747" title="All 2 branches covered."> } else if (!nullString.equals(other.nullString)) {</span> +<span class="fc" id="L748"> return false;</span> + } +<span class="fc bfc" id="L750" title="All 2 branches covered."> if (!Arrays.equals(header, other.header)) {</span> +<span class="fc" id="L751"> return false;</span> + } +<span class="fc bfc" id="L753" title="All 2 branches covered."> if (ignoreSurroundingSpaces != other.ignoreSurroundingSpaces) {</span> +<span class="fc" id="L754"> return false;</span> + } +<span class="fc bfc" id="L756" title="All 2 branches covered."> if (ignoreEmptyLines != other.ignoreEmptyLines) {</span> +<span class="fc" id="L757"> return false;</span> + } +<span class="fc bfc" id="L759" title="All 2 branches covered."> if (skipHeaderRecord != other.skipHeaderRecord) {</span> +<span class="fc" id="L760"> return false;</span> + } +<span class="fc bfc" id="L762" title="All 2 branches covered."> if (recordSeparator == null) {</span> +<span class="pc bpc" id="L763" title="1 of 2 branches missed."> if (other.recordSeparator != null) {</span> +<span class="nc" id="L764"> return false;</span> + } +<span class="fc bfc" id="L766" title="All 2 branches covered."> } else if (!recordSeparator.equals(other.recordSeparator)) {</span> +<span class="fc" id="L767"> return false;</span> + } +<span class="fc" id="L769"> return true;</span> + } + + /** + * Formats the specified values. + * + * @param values + * the values to format + * @return the formatted values + */ + public String format(final Object... values) { +<span class="fc" id="L780"> final StringWriter out = new StringWriter();</span> +<span class="fc" id="L781"> try (final CSVPrinter csvPrinter = new CSVPrinter(out, this)) {</span> +<span class="fc" id="L782"> csvPrinter.printRecord(values);</span> +<span class="fc" id="L783"> return out.toString().trim();</span> +<span class="nc" id="L784"> } catch (final IOException e) {</span> + // should not happen because a StringWriter does not do IO. +<span class="nc" id="L786"> throw new IllegalStateException(e);</span> + } + } + + /** + * Specifies whether missing column names are allowed when parsing the header line. + * + * @return {@code true} if missing column names are allowed when parsing the header line, {@code false} to throw an + * {@link IllegalArgumentException}. + */ + public boolean getAllowMissingColumnNames() { +<span class="fc" id="L797"> return allowMissingColumnNames;</span> + } + + /** + * Returns whether to flush on close. + * + * @return whether to flush on close. + * @since 1.6 + */ + public boolean getAutoFlush() { +<span class="fc" id="L807"> return autoFlush;</span> + } + + /** + * Returns the character marking the start of a line comment. + * + * @return the comment start marker, may be {@code null} + */ + public Character getCommentMarker() { +<span class="fc" id="L816"> return commentMarker;</span> + } + + /** + * Returns the character delimiting the values (typically ';', ',' or '\t'). + * + * @return the delimiter character + */ + public char getDelimiter() { +<span class="fc" id="L825"> return delimiter;</span> + } + + /** + * Returns the escape character. + * + * @return the escape character, may be {@code null} + */ + public Character getEscapeCharacter() { +<span class="fc" id="L834"> return escapeCharacter;</span> + } + + /** + * Returns a copy of the header array. + * + * @return a copy of the header array; {@code null} if disabled, the empty array if to be read from the file + */ + public String[] getHeader() { +<span class="fc bfc" id="L843" title="All 2 branches covered."> return header != null ? header.clone() : null;</span> + } + + /** + * Returns a copy of the header comment array. + * + * @return a copy of the header comment array; {@code null} if disabled. + */ + public String[] getHeaderComments() { +<span class="fc bfc" id="L852" title="All 2 branches covered."> return headerComments != null ? headerComments.clone() : null;</span> + } + + /** + * Specifies whether empty lines between records are ignored when parsing input. + * + * @return {@code true} if empty lines between records are ignored, {@code false} if they are turned into empty + * records. + */ + public boolean getIgnoreEmptyLines() { +<span class="fc" id="L862"> return ignoreEmptyLines;</span> + } + + /** + * Specifies whether header names will be accessed ignoring case. + * + * @return {@code true} if header names cases are ignored, {@code false} if they are case sensitive. + * @since 1.3 + */ + public boolean getIgnoreHeaderCase() { +<span class="fc" id="L872"> return ignoreHeaderCase;</span> + } + + /** + * Specifies whether spaces around values are ignored when parsing input. + * + * @return {@code true} if spaces around values are ignored, {@code false} if they are treated as part of the value. + */ + public boolean getIgnoreSurroundingSpaces() { +<span class="fc" id="L881"> return ignoreSurroundingSpaces;</span> + } + + /** + * Gets the String to convert to and from {@code null}. + * <ul> + * <li><strong>Reading:</strong> Converts strings equal to the given {@code nullString} to {@code null} when reading + * records.</li> + * <li><strong>Writing:</strong> Writes {@code null} as the given {@code nullString} when writing records.</li> + * </ul> + * + * @return the String to convert to and from {@code null}. No substitution occurs if {@code null} + */ + public String getNullString() { +<span class="fc" id="L895"> return nullString;</span> + } + + /** + * Returns the character used to encapsulate values containing special characters. + * + * @return the quoteChar character, may be {@code null} + */ + public Character getQuoteCharacter() { +<span class="fc" id="L904"> return quoteCharacter;</span> + } + + /** + * Returns the quote policy output fields. + * + * @return the quote policy + */ + public QuoteMode getQuoteMode() { +<span class="fc" id="L913"> return quoteMode;</span> + } + + /** + * Returns the record separator delimiting output records. + * + * @return the record separator + */ + public String getRecordSeparator() { +<span class="fc" id="L922"> return recordSeparator;</span> + } + + /** + * Returns whether to skip the header record. + * + * @return whether to skip the header record. + */ + public boolean getSkipHeaderRecord() { +<span class="fc" id="L931"> return skipHeaderRecord;</span> + } + + /** + * Returns whether to add a trailing delimiter. + * + * @return whether to add a trailing delimiter. + * @since 1.3 + */ + public boolean getTrailingDelimiter() { +<span class="fc" id="L941"> return trailingDelimiter;</span> + } + + /** + * Returns whether to trim leading and trailing blanks. + * + * @return whether to trim leading and trailing blanks. + */ + public boolean getTrim() { +<span class="fc" id="L950"> return trim;</span> + } + + @Override + public int hashCode() { +<span class="fc" id="L955"> final int prime = 31;</span> +<span class="fc" id="L956"> int result = 1;</span> + +<span class="fc" id="L958"> result = prime * result + delimiter;</span> +<span class="pc bpc" id="L959" title="1 of 2 branches missed."> result = prime * result + ((quoteMode == null) ? 0 : quoteMode.hashCode());</span> +<span class="pc bpc" id="L960" title="1 of 2 branches missed."> result = prime * result + ((quoteCharacter == null) ? 0 : quoteCharacter.hashCode());</span> +<span class="pc bpc" id="L961" title="1 of 2 branches missed."> result = prime * result + ((commentMarker == null) ? 0 : commentMarker.hashCode());</span> +<span class="pc bpc" id="L962" title="1 of 2 branches missed."> result = prime * result + ((escapeCharacter == null) ? 0 : escapeCharacter.hashCode());</span> +<span class="pc bpc" id="L963" title="1 of 2 branches missed."> result = prime * result + ((nullString == null) ? 0 : nullString.hashCode());</span> +<span class="pc bpc" id="L964" title="1 of 2 branches missed."> result = prime * result + (ignoreSurroundingSpaces ? 1231 : 1237);</span> +<span class="fc bfc" id="L965" title="All 2 branches covered."> result = prime * result + (ignoreHeaderCase ? 1231 : 1237);</span> +<span class="pc bpc" id="L966" title="1 of 2 branches missed."> result = prime * result + (ignoreEmptyLines ? 1231 : 1237);</span> +<span class="pc bpc" id="L967" title="1 of 2 branches missed."> result = prime * result + (skipHeaderRecord ? 1231 : 1237);</span> +<span class="pc bpc" id="L968" title="1 of 2 branches missed."> result = prime * result + ((recordSeparator == null) ? 0 : recordSeparator.hashCode());</span> +<span class="fc" id="L969"> result = prime * result + Arrays.hashCode(header);</span> +<span class="fc" id="L970"> return result;</span> + } + + /** + * Specifies whether comments are supported by this format. + * + * Note that the comment introducer character is only recognized at the start of a line. + * + * @return {@code true} is comments are supported, {@code false} otherwise + */ + public boolean isCommentMarkerSet() { +<span class="fc bfc" id="L981" title="All 2 branches covered."> return commentMarker != null;</span> + } + + /** + * Returns whether escape are being processed. + * + * @return {@code true} if escapes are processed + */ + public boolean isEscapeCharacterSet() { +<span class="fc bfc" id="L990" title="All 2 branches covered."> return escapeCharacter != null;</span> + } + + /** + * Returns whether a nullString has been defined. + * + * @return {@code true} if a nullString is defined + */ + public boolean isNullStringSet() { +<span class="fc bfc" id="L999" title="All 2 branches covered."> return nullString != null;</span> + } + + /** + * Returns whether a quoteChar has been defined. + * + * @return {@code true} if a quoteChar is defined + */ + public boolean isQuoteCharacterSet() { +<span class="fc bfc" id="L1008" title="All 2 branches covered."> return quoteCharacter != null;</span> + } + + /** + * Parses the specified content. + * + * <p> + * See also the various static parse methods on {@link CSVParser}. + * </p> + * + * @param in + * the input stream + * @return a parser over a stream of {@link CSVRecord}s. + * @throws IOException + * If an I/O error occurs + */ + public CSVParser parse(final Reader in) throws IOException { +<span class="fc" id="L1025"> return new CSVParser(in, this);</span> + } + + /** + * Prints to the specified output. + * + * <p> + * See also {@link CSVPrinter}. + * </p> + * + * @param out + * the output. + * @return a printer to an output. + * @throws IOException + * thrown if the optional header cannot be printed. + */ + public CSVPrinter print(final Appendable out) throws IOException { +<span class="fc" id="L1042"> return new CSVPrinter(out, this);</span> + } + + /** + * Prints to the specified output. + * + * <p> + * See also {@link CSVPrinter}. + * </p> + * + * @param out + * the output. + * @param charset + * A charset. + * @return a printer to an output. + * @throws IOException + * thrown if the optional header cannot be printed. + * @since 1.5 + */ + @SuppressWarnings("resource") + public CSVPrinter print(final File out, final Charset charset) throws IOException { + // The writer will be closed when close() is called. +<span class="fc" id="L1064"> return new CSVPrinter(new OutputStreamWriter(new FileOutputStream(out), charset), this);</span> + } + + /** + * Prints the {@code value} as the next value on the line to {@code out}. The value will be escaped or encapsulated + * as needed. Useful when one wants to avoid creating CSVPrinters. + * + * @param value + * value to output. + * @param out + * where to print the value. + * @param newRecord + * if this a new record. + * @throws IOException + * If an I/O error occurs. + * @since 1.4 + */ + public void print(final Object value, final Appendable out, final boolean newRecord) throws IOException { + // null values are considered empty + // Only call CharSequence.toString() if you have to, helps GC-free use cases. + CharSequence charSequence; +<span class="fc bfc" id="L1085" title="All 2 branches covered."> if (value == null) {</span> + // https://issues.apache.org/jira/browse/CSV-203 +<span class="fc bfc" id="L1087" title="All 2 branches covered."> if (null == nullString) {</span> +<span class="fc" id="L1088"> charSequence = EMPTY;</span> + } else { +<span class="fc bfc" id="L1090" title="All 2 branches covered."> if (QuoteMode.ALL == quoteMode) {</span> +<span class="fc" id="L1091"> charSequence = quoteCharacter + nullString + quoteCharacter;</span> + } else { +<span class="fc" id="L1093"> charSequence = nullString;</span> + } + } + } else { +<span class="fc bfc" id="L1097" title="All 2 branches covered."> charSequence = value instanceof CharSequence ? (CharSequence) value : value.toString();</span> + } +<span class="fc bfc" id="L1099" title="All 2 branches covered."> charSequence = getTrim() ? trim(charSequence) : charSequence;</span> +<span class="fc" id="L1100"> this.print(value, charSequence, 0, charSequence.length(), out, newRecord);</span> +<span class="fc" id="L1101"> }</span> + + private void print(final Object object, final CharSequence value, final int offset, final int len, + final Appendable out, final boolean newRecord) throws IOException { +<span class="fc bfc" id="L1105" title="All 2 branches covered."> if (!newRecord) {</span> +<span class="fc" id="L1106"> out.append(getDelimiter());</span> + } +<span class="fc bfc" id="L1108" title="All 2 branches covered."> if (object == null) {</span> +<span class="fc" id="L1109"> out.append(value);</span> +<span class="fc bfc" id="L1110" title="All 2 branches covered."> } else if (isQuoteCharacterSet()) {</span> + // the original object is needed so can check for Number +<span class="fc" id="L1112"> printAndQuote(object, value, offset, len, out, newRecord);</span> +<span class="fc bfc" id="L1113" title="All 2 branches covered."> } else if (isEscapeCharacterSet()) {</span> +<span class="fc" id="L1114"> printAndEscape(value, offset, len, out);</span> + } else { +<span class="fc" id="L1116"> out.append(value, offset, offset + len);</span> + } +<span class="fc" id="L1118"> }</span> + + /** + * Prints to the specified output. + * + * <p> + * See also {@link CSVPrinter}. + * </p> + * + * @param out + * the output. + * @param charset + * A charset. + * @return a printer to an output. + * @throws IOException + * thrown if the optional header cannot be printed. + * @since 1.5 + */ + public CSVPrinter print(final Path out, final Charset charset) throws IOException { +<span class="fc" id="L1137"> return print(Files.newBufferedWriter(out, charset));</span> + } + + /* + * Note: must only be called if escaping is enabled, otherwise will generate NPE + */ + private void printAndEscape(final CharSequence value, final int offset, final int len, final Appendable out) + throws IOException { +<span class="fc" id="L1145"> int start = offset;</span> +<span class="fc" id="L1146"> int pos = offset;</span> +<span class="fc" id="L1147"> final int end = offset + len;</span> + +<span class="fc" id="L1149"> final char delim = getDelimiter();</span> +<span class="fc" id="L1150"> final char escape = getEscapeCharacter().charValue();</span> + +<span class="fc bfc" id="L1152" title="All 2 branches covered."> while (pos < end) {</span> +<span class="fc" id="L1153"> char c = value.charAt(pos);</span> +<span class="fc bfc" id="L1154" title="All 8 branches covered."> if (c == CR || c == LF || c == delim || c == escape) {</span> + // write out segment up until this char +<span class="fc bfc" id="L1156" title="All 2 branches covered."> if (pos > start) {</span> +<span class="fc" id="L1157"> out.append(value, start, pos);</span> + } +<span class="fc bfc" id="L1159" title="All 2 branches covered."> if (c == LF) {</span> +<span class="fc" id="L1160"> c = 'n';</span> +<span class="fc bfc" id="L1161" title="All 2 branches covered."> } else if (c == CR) {</span> +<span class="fc" id="L1162"> c = 'r';</span> + } + +<span class="fc" id="L1165"> out.append(escape);</span> +<span class="fc" id="L1166"> out.append(c);</span> + +<span class="fc" id="L1168"> start = pos + 1; // start on the current char after this one</span> + } + +<span class="fc" id="L1171"> pos++;</span> +<span class="fc" id="L1172"> }</span> + + // write last segment +<span class="fc bfc" id="L1175" title="All 2 branches covered."> if (pos > start) {</span> +<span class="fc" id="L1176"> out.append(value, start, pos);</span> + } +<span class="fc" id="L1178"> }</span> + + /* + * Note: must only be called if quoting is enabled, otherwise will generate NPE + */ + // the original object is needed so can check for Number + private void printAndQuote(final Object object, final CharSequence value, final int offset, final int len, + final Appendable out, final boolean newRecord) throws IOException { +<span class="fc" id="L1186"> boolean quote = false;</span> +<span class="fc" id="L1187"> int start = offset;</span> +<span class="fc" id="L1188"> int pos = offset;</span> +<span class="fc" id="L1189"> final int end = offset + len;</span> + +<span class="fc" id="L1191"> final char delimChar = getDelimiter();</span> +<span class="fc" id="L1192"> final char quoteChar = getQuoteCharacter().charValue();</span> + +<span class="fc" id="L1194"> QuoteMode quoteModePolicy = getQuoteMode();</span> +<span class="fc bfc" id="L1195" title="All 2 branches covered."> if (quoteModePolicy == null) {</span> +<span class="fc" id="L1196"> quoteModePolicy = QuoteMode.MINIMAL;</span> + } +<span class="pc bpc" id="L1198" title="1 of 5 branches missed."> switch (quoteModePolicy) {</span> + case ALL: + case ALL_NON_NULL: +<span class="fc" id="L1201"> quote = true;</span> +<span class="fc" id="L1202"> break;</span> + case NON_NUMERIC: +<span class="fc bfc" id="L1204" title="All 2 branches covered."> quote = !(object instanceof Number);</span> +<span class="fc" id="L1205"> break;</span> + case NONE: + // Use the existing escaping code +<span class="fc" id="L1208"> printAndEscape(value, offset, len, out);</span> +<span class="fc" id="L1209"> return;</span> + case MINIMAL: +<span class="fc bfc" id="L1211" title="All 2 branches covered."> if (len <= 0) {</span> + // always quote an empty token that is the first + // on the line, as it may be the only thing on the + // line. If it were not quoted in that case, + // an empty line has no tokens. +<span class="fc bfc" id="L1216" title="All 2 branches covered."> if (newRecord) {</span> +<span class="fc" id="L1217"> quote = true;</span> + } + } else { +<span class="fc" id="L1220"> char c = value.charAt(pos);</span> + +<span class="fc bfc" id="L1222" title="All 2 branches covered."> if (c <= COMMENT) {</span> + // Some other chars at the start of a value caused the parser to fail, so for now + // encapsulate if we start in anything less than '#'. We are being conservative + // by including the default comment char too. +<span class="fc" id="L1226"> quote = true;</span> + } else { +<span class="fc bfc" id="L1228" title="All 2 branches covered."> while (pos < end) {</span> +<span class="fc" id="L1229"> c = value.charAt(pos);</span> +<span class="fc bfc" id="L1230" title="All 8 branches covered."> if (c == LF || c == CR || c == quoteChar || c == delimChar) {</span> +<span class="fc" id="L1231"> quote = true;</span> +<span class="fc" id="L1232"> break;</span> + } +<span class="fc" id="L1234"> pos++;</span> + } + +<span class="fc bfc" id="L1237" title="All 2 branches covered."> if (!quote) {</span> +<span class="fc" id="L1238"> pos = end - 1;</span> +<span class="fc" id="L1239"> c = value.charAt(pos);</span> + // Some other chars at the end caused the parser to fail, so for now + // encapsulate if we end in anything less than ' ' +<span class="fc bfc" id="L1242" title="All 2 branches covered."> if (c <= SP) {</span> +<span class="fc" id="L1243"> quote = true;</span> + } + } + } + } + +<span class="fc bfc" id="L1249" title="All 2 branches covered."> if (!quote) {</span> + // no encapsulation needed - write out the original value +<span class="fc" id="L1251"> out.append(value, start, end);</span> +<span class="fc" id="L1252"> return;</span> + } + break; + default: +<span class="nc" id="L1256"> throw new IllegalStateException("Unexpected Quote value: " + quoteModePolicy);</span> + } + +<span class="fc bfc" id="L1259" title="All 2 branches covered."> if (!quote) {</span> + // no encapsulation needed - write out the original value +<span class="fc" id="L1261"> out.append(value, start, end);</span> +<span class="fc" id="L1262"> return;</span> + } + + // we hit something that needed encapsulation +<span class="fc" id="L1266"> out.append(quoteChar);</span> + + // Pick up where we left off: pos should be positioned on the first character that caused + // the need for encapsulation. +<span class="fc bfc" id="L1270" title="All 2 branches covered."> while (pos < end) {</span> +<span class="fc" id="L1271"> final char c = value.charAt(pos);</span> +<span class="fc bfc" id="L1272" title="All 2 branches covered."> if (c == quoteChar) {</span> + // write out the chunk up until this point + + // add 1 to the length to write out the encapsulator also +<span class="fc" id="L1276"> out.append(value, start, pos + 1);</span> + // put the next starting position on the encapsulator so we will + // write it out again with the next string (effectively doubling it) +<span class="fc" id="L1279"> start = pos;</span> + } +<span class="fc" id="L1281"> pos++;</span> +<span class="fc" id="L1282"> }</span> + + // write the last segment +<span class="fc" id="L1285"> out.append(value, start, pos);</span> +<span class="fc" id="L1286"> out.append(quoteChar);</span> +<span class="fc" id="L1287"> }</span> + + /** + * Prints to the {@link System#out}. + * + * <p> + * See also {@link CSVPrinter}. + * </p> + * + * @return a printer to {@link System#out}. + * @throws IOException + * thrown if the optional header cannot be printed. + * @since 1.5 + */ + public CSVPrinter printer() throws IOException { +<span class="fc" id="L1302"> return new CSVPrinter(System.out, this);</span> + } + + /** + * Outputs the trailing delimiter (if set) followed by the record separator (if set). + * + * @param out + * where to write + * @throws IOException + * If an I/O error occurs + * @since 1.4 + */ + public void println(final Appendable out) throws IOException { +<span class="fc bfc" id="L1315" title="All 2 branches covered."> if (getTrailingDelimiter()) {</span> +<span class="fc" id="L1316"> out.append(getDelimiter());</span> + } +<span class="fc bfc" id="L1318" title="All 2 branches covered."> if (recordSeparator != null) {</span> +<span class="fc" id="L1319"> out.append(recordSeparator);</span> + } +<span class="fc" id="L1321"> }</span> + + /** + * Prints the given {@code values} to {@code out} as a single record of delimiter separated values followed by the + * record separator. + * + * <p> + * The values will be quoted if needed. Quotes and new-line characters will be escaped. This method adds the record + * separator to the output after printing the record, so there is no need to call {@link #println(Appendable)}. + * </p> + * + * @param out + * where to write. + * @param values + * values to output. + * @throws IOException + * If an I/O error occurs. + * @since 1.4 + */ + public void printRecord(final Appendable out, final Object... values) throws IOException { +<span class="fc bfc" id="L1341" title="All 2 branches covered."> for (int i = 0; i < values.length; i++) {</span> +<span class="fc bfc" id="L1342" title="All 2 branches covered."> print(values[i], out, i == 0);</span> + } +<span class="fc" id="L1344"> println(out);</span> +<span class="fc" id="L1345"> }</span> + + @Override + public String toString() { +<span class="fc" id="L1349"> final StringBuilder sb = new StringBuilder();</span> +<span class="fc" id="L1350"> sb.append("Delimiter=<").append(delimiter).append('>');</span> +<span class="fc bfc" id="L1351" title="All 2 branches covered."> if (isEscapeCharacterSet()) {</span> +<span class="fc" id="L1352"> sb.append(' ');</span> +<span class="fc" id="L1353"> sb.append("Escape=<").append(escapeCharacter).append('>');</span> + } +<span class="pc bpc" id="L1355" title="1 of 2 branches missed."> if (isQuoteCharacterSet()) {</span> +<span class="fc" id="L1356"> sb.append(' ');</span> +<span class="fc" id="L1357"> sb.append("QuoteChar=<").append(quoteCharacter).append('>');</span> + } +<span class="fc bfc" id="L1359" title="All 2 branches covered."> if (isCommentMarkerSet()) {</span> +<span class="fc" id="L1360"> sb.append(' ');</span> +<span class="fc" id="L1361"> sb.append("CommentStart=<").append(commentMarker).append('>');</span> + } +<span class="pc bpc" id="L1363" title="1 of 2 branches missed."> if (isNullStringSet()) {</span> +<span class="nc" id="L1364"> sb.append(' ');</span> +<span class="nc" id="L1365"> sb.append("NullString=<").append(nullString).append('>');</span> + } +<span class="fc bfc" id="L1367" title="All 2 branches covered."> if (recordSeparator != null) {</span> +<span class="fc" id="L1368"> sb.append(' ');</span> +<span class="fc" id="L1369"> sb.append("RecordSeparator=<").append(recordSeparator).append('>');</span> + } +<span class="fc bfc" id="L1371" title="All 2 branches covered."> if (getIgnoreEmptyLines()) {</span> +<span class="fc" id="L1372"> sb.append(" EmptyLines:ignored");</span> + } +<span class="fc bfc" id="L1374" title="All 2 branches covered."> if (getIgnoreSurroundingSpaces()) {</span> +<span class="fc" id="L1375"> sb.append(" SurroundingSpaces:ignored");</span> + } +<span class="pc bpc" id="L1377" title="1 of 2 branches missed."> if (getIgnoreHeaderCase()) {</span> +<span class="nc" id="L1378"> sb.append(" IgnoreHeaderCase:ignored");</span> + } +<span class="fc" id="L1380"> sb.append(" SkipHeaderRecord:").append(skipHeaderRecord);</span> +<span class="pc bpc" id="L1381" title="1 of 2 branches missed."> if (headerComments != null) {</span> +<span class="nc" id="L1382"> sb.append(' ');</span> +<span class="nc" id="L1383"> sb.append("HeaderComments:").append(Arrays.toString(headerComments));</span> + } +<span class="pc bpc" id="L1385" title="1 of 2 branches missed."> if (header != null) {</span> +<span class="nc" id="L1386"> sb.append(' ');</span> +<span class="nc" id="L1387"> sb.append("Header:").append(Arrays.toString(header));</span> + } +<span class="fc" id="L1389"> return sb.toString();</span> + } + + private String[] toStringArray(final Object[] values) { +<span class="fc bfc" id="L1393" title="All 2 branches covered."> if (values == null) {</span> +<span class="fc" id="L1394"> return null;</span> + } +<span class="fc" id="L1396"> final String[] strings = new String[values.length];</span> +<span class="fc bfc" id="L1397" title="All 2 branches covered."> for (int i = 0; i < values.length; i++) {</span> +<span class="fc" id="L1398"> final Object value = values[i];</span> +<span class="fc bfc" id="L1399" title="All 2 branches covered."> strings[i] = value == null ? null : value.toString();</span> + } +<span class="fc" id="L1401"> return strings;</span> + } + + private CharSequence trim(final CharSequence charSequence) { +<span class="pc bpc" id="L1405" title="1 of 2 branches missed."> if (charSequence instanceof String) {</span> +<span class="fc" id="L1406"> return ((String) charSequence).trim();</span> + } +<span class="nc" id="L1408"> final int count = charSequence.length();</span> +<span class="nc" id="L1409"> int len = count;</span> +<span class="nc" id="L1410"> int pos = 0;</span> + +<span class="nc bnc" id="L1412" title="All 4 branches missed."> while (pos < len && charSequence.charAt(pos) <= SP) {</span> +<span class="nc" id="L1413"> pos++;</span> + } +<span class="nc bnc" id="L1415" title="All 4 branches missed."> while (pos < len && charSequence.charAt(len - 1) <= SP) {</span> +<span class="nc" id="L1416"> len--;</span> + } +<span class="nc bnc" id="L1418" title="All 4 branches missed."> return pos > 0 || len < count ? charSequence.subSequence(pos, len) : charSequence;</span> + } + + /** + * Verifies the consistency of the parameters and throws an IllegalArgumentException if necessary. + * + * @throws IllegalArgumentException + */ + private void validate() throws IllegalArgumentException { +<span class="pc bpc" id="L1427" title="1 of 2 branches missed."> if (isLineBreak(delimiter)) {</span> +<span class="nc" id="L1428"> throw new IllegalArgumentException("The delimiter cannot be a line break");</span> + } + +<span class="fc bfc" id="L1431" title="All 4 branches covered."> if (quoteCharacter != null && delimiter == quoteCharacter.charValue()) {</span> +<span class="fc" id="L1432"> throw new IllegalArgumentException(</span> + "The quoteChar character and the delimiter cannot be the same ('" + quoteCharacter + "')"); + } + +<span class="fc bfc" id="L1436" title="All 4 branches covered."> if (escapeCharacter != null && delimiter == escapeCharacter.charValue()) {</span> +<span class="fc" id="L1437"> throw new IllegalArgumentException(</span> + "The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')"); + } + +<span class="fc bfc" id="L1441" title="All 4 branches covered."> if (commentMarker != null && delimiter == commentMarker.charValue()) {</span> +<span class="fc" id="L1442"> throw new IllegalArgumentException(</span> + "The comment start character and the delimiter cannot be the same ('" + commentMarker + "')"); + } + +<span class="fc bfc" id="L1446" title="All 4 branches covered."> if (quoteCharacter != null && quoteCharacter.equals(commentMarker)) {</span> +<span class="fc" id="L1447"> throw new IllegalArgumentException(</span> + "The comment start character and the quoteChar cannot be the same ('" + commentMarker + "')"); + } + +<span class="fc bfc" id="L1451" title="All 4 branches covered."> if (escapeCharacter != null && escapeCharacter.equals(commentMarker)) {</span> +<span class="fc" id="L1452"> throw new IllegalArgumentException(</span> + "The comment start and the escape character cannot be the same ('" + commentMarker + "')"); + } + +<span class="fc bfc" id="L1456" title="All 4 branches covered."> if (escapeCharacter == null && quoteMode == QuoteMode.NONE) {</span> +<span class="fc" id="L1457"> throw new IllegalArgumentException("No quotes mode set but no escape character is set");</span> + } + + // validate header +<span class="fc bfc" id="L1461" title="All 2 branches covered."> if (header != null) {</span> +<span class="fc" id="L1462"> final Set<String> dupCheck = new HashSet<>();</span> +<span class="fc bfc" id="L1463" title="All 2 branches covered."> for (final String hdr : header) {</span> +<span class="fc bfc" id="L1464" title="All 2 branches covered."> if (!dupCheck.add(hdr)) {</span> +<span class="fc" id="L1465"> throw new IllegalArgumentException(</span> +<span class="fc" id="L1466"> "The header contains a duplicate entry: '" + hdr + "' in " + Arrays.toString(header));</span> + } + } + } +<span class="fc" id="L1470"> }</span> + + /** + * Returns a new {@code CSVFormat} with the missing column names behavior of the format set to {@code true} + * + * @return A new CSVFormat that is equal to this but with the specified missing column names behavior. + * @see #withAllowMissingColumnNames(boolean) + * @since 1.1 + */ + public CSVFormat withAllowMissingColumnNames() { +<span class="fc" id="L1480"> return this.withAllowMissingColumnNames(true);</span> + } + + /** + * Returns a new {@code CSVFormat} with the missing column names behavior of the format set to the given value. + * + * @param allowMissingColumnNames + * the missing column names behavior, {@code true} to allow missing column names in the header line, + * {@code false} to cause an {@link IllegalArgumentException} to be thrown. + * @return A new CSVFormat that is equal to this but with the specified missing column names behavior. + */ + public CSVFormat withAllowMissingColumnNames(final boolean allowMissingColumnNames) { +<span class="fc" id="L1492"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with whether to flush on close. + * + * @param autoFlush + * whether to flush on close. + * + * @return A new CSVFormat that is equal to this but with the specified autoFlush setting. + * @since 1.6 + */ + public CSVFormat withAutoFlush(final boolean autoFlush) { +<span class="fc" id="L1507"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the comment start marker of the format set to the specified character. + * + * Note that the comment start character is only recognized at the start of a line. + * + * @param commentMarker + * the comment start marker + * @return A new CSVFormat that is equal to this one but with the specified character as the comment start marker + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withCommentMarker(final char commentMarker) { +<span class="fc" id="L1524"> return withCommentMarker(Character.valueOf(commentMarker));</span> + } + + /** + * Returns a new {@code CSVFormat} with the comment start marker of the format set to the specified character. + * + * Note that the comment start character is only recognized at the start of a line. + * + * @param commentMarker + * the comment start marker, use {@code null} to disable + * @return A new CSVFormat that is equal to this one but with the specified character as the comment start marker + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withCommentMarker(final Character commentMarker) { +<span class="fc bfc" id="L1539" title="All 2 branches covered."> if (isLineBreak(commentMarker)) {</span> +<span class="fc" id="L1540"> throw new IllegalArgumentException("The comment start marker character cannot be a line break");</span> + } +<span class="fc" id="L1542"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the delimiter of the format set to the specified character. + * + * @param delimiter + * the delimiter character + * @return A new CSVFormat that is equal to this with the specified character as delimiter + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withDelimiter(final char delimiter) { +<span class="fc bfc" id="L1557" title="All 2 branches covered."> if (isLineBreak(delimiter)) {</span> +<span class="fc" id="L1558"> throw new IllegalArgumentException("The delimiter cannot be a line break");</span> + } +<span class="fc" id="L1560"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the escape character of the format set to the specified character. + * + * @param escape + * the escape character + * @return A new CSVFormat that is equal to his but with the specified character as the escape character + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withEscape(final char escape) { +<span class="fc" id="L1575"> return withEscape(Character.valueOf(escape));</span> + } + + /** + * Returns a new {@code CSVFormat} with the escape character of the format set to the specified character. + * + * @param escape + * the escape character, use {@code null} to disable + * @return A new CSVFormat that is equal to this but with the specified character as the escape character + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withEscape(final Character escape) { +<span class="fc bfc" id="L1588" title="All 2 branches covered."> if (isLineBreak(escape)) {</span> +<span class="fc" id="L1589"> throw new IllegalArgumentException("The escape character cannot be a line break");</span> + } +<span class="fc" id="L1591"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escape, ignoreSurroundingSpaces,</span> + ignoreEmptyLines, recordSeparator, nullString, headerComments, header, skipHeaderRecord, + allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} using the first record as header. + * + * <p> + * Calling this method is equivalent to calling: + * </p> + * + * <pre> + * CSVFormat format = aFormat.withHeader().withSkipHeaderRecord(); + * </pre> + * + * @return A new CSVFormat that is equal to this but using the first record as header. + * @see #withSkipHeaderRecord(boolean) + * @see #withHeader(String...) + * @since 1.3 + */ + public CSVFormat withFirstRecordAsHeader() { +<span class="fc" id="L1613"> return withHeader().withSkipHeaderRecord();</span> + } + + /** + * Returns a new {@code CSVFormat} with the header of the format defined by the enum class. + * + * <p> + * Example: + * </p> + * <pre> + * public enum Header { + * Name, Email, Phone + * } + * + * CSVFormat format = aformat.withHeader(Header.class); + * </pre> + * <p> + * The header is also used by the {@link CSVPrinter}. + * </p> + * + * @param headerEnum + * the enum defining the header, {@code null} if disabled, empty if parsed automatically, user specified + * otherwise. + * + * @return A new CSVFormat that is equal to this but with the specified header + * @see #withHeader(String...) + * @see #withSkipHeaderRecord(boolean) + * @since 1.3 + */ + public CSVFormat withHeader(final Class<? extends Enum<?>> headerEnum) { +<span class="fc" id="L1643"> String[] header = null;</span> +<span class="pc bpc" id="L1644" title="1 of 2 branches missed."> if (headerEnum != null) {</span> +<span class="fc" id="L1645"> final Enum<?>[] enumValues = headerEnum.getEnumConstants();</span> +<span class="fc" id="L1646"> header = new String[enumValues.length];</span> +<span class="fc bfc" id="L1647" title="All 2 branches covered."> for (int i = 0; i < enumValues.length; i++) {</span> +<span class="fc" id="L1648"> header[i] = enumValues[i].name();</span> + } + } +<span class="fc" id="L1651"> return withHeader(header);</span> + } + + /** + * Returns a new {@code CSVFormat} with the header of the format set from the result set metadata. The header can + * either be parsed automatically from the input file with: + * + * <pre> + * CSVFormat format = aformat.withHeader(); + * </pre> + * + * or specified manually with: + * + * <pre> + * CSVFormat format = aformat.withHeader(resultSet); + * </pre> + * <p> + * The header is also used by the {@link CSVPrinter}. + * </p> + * + * @param resultSet + * the resultSet for the header, {@code null} if disabled, empty if parsed automatically, user specified + * otherwise. + * + * @return A new CSVFormat that is equal to this but with the specified header + * @throws SQLException + * SQLException if a database access error occurs or this method is called on a closed result set. + * @since 1.1 + */ + public CSVFormat withHeader(final ResultSet resultSet) throws SQLException { +<span class="pc bpc" id="L1681" title="1 of 2 branches missed."> return withHeader(resultSet != null ? resultSet.getMetaData() : null);</span> + } + + /** + * Returns a new {@code CSVFormat} with the header of the format set from the result set metadata. The header can + * either be parsed automatically from the input file with: + * + * <pre> + * CSVFormat format = aformat.withHeader(); + * </pre> + * + * or specified manually with: + * + * <pre> + * CSVFormat format = aformat.withHeader(metaData); + * </pre> + * <p> + * The header is also used by the {@link CSVPrinter}. + * </p> + * + * @param metaData + * the metaData for the header, {@code null} if disabled, empty if parsed automatically, user specified + * otherwise. + * + * @return A new CSVFormat that is equal to this but with the specified header + * @throws SQLException + * SQLException if a database access error occurs or this method is called on a closed result set. + * @since 1.1 + */ + public CSVFormat withHeader(final ResultSetMetaData metaData) throws SQLException { +<span class="fc" id="L1711"> String[] labels = null;</span> +<span class="pc bpc" id="L1712" title="1 of 2 branches missed."> if (metaData != null) {</span> +<span class="fc" id="L1713"> final int columnCount = metaData.getColumnCount();</span> +<span class="fc" id="L1714"> labels = new String[columnCount];</span> +<span class="fc bfc" id="L1715" title="All 2 branches covered."> for (int i = 0; i < columnCount; i++) {</span> +<span class="fc" id="L1716"> labels[i] = metaData.getColumnLabel(i + 1);</span> + } + } +<span class="fc" id="L1719"> return withHeader(labels);</span> + } + + /** + * Returns a new {@code CSVFormat} with the header of the format set to the given values. The header can either be + * parsed automatically from the input file with: + * + * <pre> + * CSVFormat format = aformat.withHeader(); + * </pre> + * + * or specified manually with: + * + * <pre> + * CSVFormat format = aformat.withHeader(&quot;name&quot;, &quot;email&quot;, &quot;phone&quot;); + * </pre> + * <p> + * The header is also used by the {@link CSVPrinter}. + * </p> + * + * @param header + * the header, {@code null} if disabled, empty if parsed automatically, user specified otherwise. + * + * @return A new CSVFormat that is equal to this but with the specified header + * @see #withSkipHeaderRecord(boolean) + */ + public CSVFormat withHeader(final String... header) { +<span class="fc" id="L1746"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the header comments of the format set to the given values. The comments will + * be printed first, before the headers. This setting is ignored by the parser. + * + * <pre> + * CSVFormat format = aformat.withHeaderComments(&quot;Generated by Apache Commons CSV 1.1.&quot;, new Date()); + * </pre> + * + * @param headerComments + * the headerComments which will be printed by the Printer before the actual CSV data. + * + * @return A new CSVFormat that is equal to this but with the specified header + * @see #withSkipHeaderRecord(boolean) + * @since 1.1 + */ + public CSVFormat withHeaderComments(final Object... headerComments) { +<span class="fc" id="L1767"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the empty line skipping behavior of the format set to {@code true}. + * + * @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior. + * @since {@link #withIgnoreEmptyLines(boolean)} + * @since 1.1 + */ + public CSVFormat withIgnoreEmptyLines() { +<span class="fc" id="L1780"> return this.withIgnoreEmptyLines(true);</span> + } + + /** + * Returns a new {@code CSVFormat} with the empty line skipping behavior of the format set to the given value. + * + * @param ignoreEmptyLines + * the empty line skipping behavior, {@code true} to ignore the empty lines between the records, + * {@code false} to translate empty lines to empty records. + * @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior. + */ + public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) { +<span class="fc" id="L1792"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the header ignore case behavior set to {@code true}. + * + * @return A new CSVFormat that will ignore case header name. + * @see #withIgnoreHeaderCase(boolean) + * @since 1.3 + */ + public CSVFormat withIgnoreHeaderCase() { +<span class="fc" id="L1805"> return this.withIgnoreHeaderCase(true);</span> + } + + /** + * Returns a new {@code CSVFormat} with whether header names should be accessed ignoring case. + * + * @param ignoreHeaderCase + * the case mapping behavior, {@code true} to access name/values, {@code false} to leave the mapping as + * is. + * @return A new CSVFormat that will ignore case header name if specified as {@code true} + * @since 1.3 + */ + public CSVFormat withIgnoreHeaderCase(final boolean ignoreHeaderCase) { +<span class="fc" id="L1818"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the trimming behavior of the format set to {@code true}. + * + * @return A new CSVFormat that is equal to this but with the specified trimming behavior. + * @see #withIgnoreSurroundingSpaces(boolean) + * @since 1.1 + */ + public CSVFormat withIgnoreSurroundingSpaces() { +<span class="fc" id="L1831"> return this.withIgnoreSurroundingSpaces(true);</span> + } + + /** + * Returns a new {@code CSVFormat} with the trimming behavior of the format set to the given value. + * + * @param ignoreSurroundingSpaces + * the trimming behavior, {@code true} to remove the surrounding spaces, {@code false} to leave the + * spaces as is. + * @return A new CSVFormat that is equal to this but with the specified trimming behavior. + */ + public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpaces) { +<span class="fc" id="L1843"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with conversions to and from null for strings on input and output. + * <ul> + * <li><strong>Reading:</strong> Converts strings equal to the given {@code nullString} to {@code null} when reading + * records.</li> + * <li><strong>Writing:</strong> Writes {@code null} as the given {@code nullString} when writing records.</li> + * </ul> + * + * @param nullString + * the String to convert to and from {@code null}. No substitution occurs if {@code null} + * + * @return A new CSVFormat that is equal to this but with the specified null conversion string. + */ + public CSVFormat withNullString(final String nullString) { +<span class="fc" id="L1862"> return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,</span> + ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, headerComments, header, + skipHeaderRecord, allowMissingColumnNames, ignoreHeaderCase, trim, trailingDelimiter, autoFlush); + } + + /** + * Returns a new {@code CSVFormat} with the quoteChar of the format set to the specified character. + * + * @param quoteChar + * the quoteChar character + * @return A new CSVFormat that is equal to this but with the specified character as quoteChar + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */ + public CSVFormat withQuote(final char quoteChar) { +<span class="fc" id="L1877"> return withQuote(Character.valueOf(quoteChar));</span> + } + + /** + * Returns a new {@code CSVFormat} with the quoteChar of the format set to the specified character. + * + * @param quoteChar + * the quoteChar character, use {@code null} to disable + * @return A new CSVFormat that is equal to this but with the specified character as quoteChar + * @throws IllegalArgumentException + * thrown if the specified character is a line break + */
[... 157 lines stripped ...]
