# Uses of Class org.apache.commons.csv.CSVFormat (Apache Commons CSV 1.2 API)

## Uses of Class
org.apache.commons.csv.CSVFormat

- - ### Uses of CSVFormat in org.apache.commons.csv

    Fields in org.apache.commons.csv declared as CSVFormat
    Modifier and Type | Field and Description
    --- | ---
    `static CSVFormat` | CSVFormat.`DEFAULT` Standard comma separated format, as for `RFC4180` but allowing empty lines.
    `static CSVFormat` | CSVFormat.`EXCEL` Excel file format (using a comma as the value delimiter).
    `static CSVFormat` | CSVFormat.`MYSQL` Default MySQL format used by the `SELECT INTO OUTFILE` and `LOAD DATA INFILE` operations.
    `static CSVFormat` | CSVFormat.`RFC4180` Comma separated format as defined by RFC 4180.
    `static CSVFormat` | CSVFormat.`TDF` Tab-delimited format.

    Methods in org.apache.commons.csv that return CSVFormat
    Modifier and Type | Method and Description
    --- | ---
    `CSVFormat` | CSVFormat.Predefined.`getFormat()` Gets the format.
    `static CSVFormat` | CSVFormat.`newFormat(char delimiter)` Creates a new CSV format with the specified delimiter.
    `static CSVFormat` | CSVFormat.`valueOf(String format)` Gets one of the predefined formats from `CSVFormat.Predefined`.
    `CSVFormat` | CSVFormat.`withAllowMissingColumnNames()` Sets the missing column names behavior of the format to `true`
    `CSVFormat` | CSVFormat.`withAllowMissingColumnNames(boolean allowMissingColumnNames)` Sets the missing column names behavior of the format.
    `CSVFormat` | CSVFormat.`withCommentMarker(char commentMarker)` Sets the comment start marker of the format to the specified character.
    `CSVFormat` | CSVFormat.`withCommentMarker(Character commentMarker)` Sets the comment start marker of the format to the specified character.
    `CSVFormat` | CSVFormat.`withDelimiter(char delimiter)` Sets the delimiter of the format to the specified character.
    `CSVFormat` | CSVFormat.`withEscape(char escape)` Sets the escape character of the format to the specified character.
    `CSVFormat` | CSVFormat.`withEscape(Character escape)` Sets the escape character of the format to the specified character.
    `CSVFormat` | CSVFormat.`withHeader(ResultSet resultSet)` Sets the header of the format.
    `CSVFormat` | CSVFormat.`withHeader(ResultSetMetaData metaData)` Sets the header of the format.
    `CSVFormat` | CSVFormat.`withHeader(String... header)` Sets the header of the format.
    `CSVFormat` | CSVFormat.`withHeaderComments(Object... headerComments)` Sets the header comments of the format.
    `CSVFormat` | CSVFormat.`withIgnoreEmptyLines()` Sets the empty line skipping behavior of the format to `true`.
    `CSVFormat` | CSVFormat.`withIgnoreEmptyLines(boolean ignoreEmptyLines)` Sets the empty line skipping behavior of the format.
    `CSVFormat` | CSVFormat.`withIgnoreSurroundingSpaces()` Sets the trimming behavior of the format to `true`.
    `CSVFormat` | CSVFormat.`withIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces)` Sets the trimming behavior of the format.
    `CSVFormat` | CSVFormat.`withNullString(String nullString)` Performs conversions to and from null for strings on input and output.
    `CSVFormat` | CSVFormat.`withQuote(char quoteChar)` Sets the quoteChar of the format to the specified character.
    `CSVFormat` | CSVFormat.`withQuote(Character quoteChar)` Sets the quoteChar of the format to the specified character.
    `CSVFormat` | CSVFormat.`withQuoteMode(QuoteMode quoteModePolicy)` Sets the output quote policy of the format to the specified value.
    `CSVFormat` | CSVFormat.`withRecordSeparator(char recordSeparator)` Sets the record separator of the format to the specified character.
    `CSVFormat` | CSVFormat.`withRecordSeparator(String recordSeparator)` Sets the record separator of the format to the specified String.
    `CSVFormat` | CSVFormat.`withSkipHeaderRecord()` Sets skipping the header record to `true`.
    `CSVFormat` | CSVFormat.`withSkipHeaderRecord(boolean skipHeaderRecord)` Sets whether to skip the header record.

    Methods in org.apache.commons.csv with parameters of type CSVFormat
    Modifier and Type | Method and Description
    --- | ---
    `static CSVParser` | CSVParser.`parse(File file, Charset charset, CSVFormat format)` Creates a parser for the given `File`.
    `static CSVParser` | CSVParser.`parse(String string, CSVFormat format)` Creates a parser for the given `String`.
    `static CSVParser` | CSVParser.`parse(URL url, Charset charset, CSVFormat format)` Creates a parser for the given URL.

    Constructors in org.apache.commons.csv with parameters of type CSVFormat
    Constructor and Description
    `CSVParser(Reader reader, CSVFormat format)` Customized CSV parser using the given `CSVFormat`
    `CSVParser(Reader reader, CSVFormat format, long characterOffset, long recordNumber)` Customized CSV parser using the given `CSVFormat`
    `CSVPrinter(Appendable out, CSVFormat format)` Creates a printer that will print values to the given stream following the CSVFormat.

Copyright © 2015 The Apache Software Foundation. All rights reserved.