de.siegmar.fastcsv.writer

Class CsvWriter.CsvWriterBuilder

java.lang.Object

de.siegmar.fastcsv.writer.CsvWriter.CsvWriterBuilder

Enclosing class:

CsvWriter

public static final class CsvWriter.CsvWriterBuilder
extends java.lang.Object

This builder is used to create configured instances of CsvWriter. The default configuration of this class complies with RFC 4180.

Method Summary

Modifier and Type	Method and Description
CsvWriter.CsvWriterBuilder	bufferSize(int bufferSize) Configures the size of the internal buffer.
CsvWriter	build(java.nio.file.Path path, java.nio.charset.Charset charset, java.nio.file.OpenOption... openOptions) Constructs a CsvWriter for the specified Path.
CsvWriter	build(java.nio.file.Path path, java.nio.file.OpenOption... openOptions) Constructs a CsvWriter for the specified Path.
CsvWriter	build(java.io.Writer writer) Constructs a CsvWriter for the specified Writer.
CsvWriter.CsvWriterBuilder	commentCharacter(char commentCharacter) Sets the character that is used to prepend commented lines (default: '#' - hash/number).
CsvWriter.CsvWriterBuilder	fieldSeparator(char fieldSeparator) Sets the character that is used to separate columns (default: ',' - comma).
CsvWriter.CsvWriterBuilder	lineDelimiter(LineDelimiter lineDelimiter) Sets the delimiter that is used to separate lines (default: LineDelimiter.CRLF).
CsvWriter.CsvWriterBuilder	quoteCharacter(char quoteCharacter) Sets the character that is used to quote values (default: '"' - double quotes).
CsvWriter.CsvWriterBuilder	quoteStrategy(QuoteStrategy quoteStrategy) Sets the strategy that defines when quoting has to be performed (default: QuoteStrategy.REQUIRED).
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

fieldSeparator

public CsvWriter.CsvWriterBuilder fieldSeparator(char fieldSeparator)

Sets the character that is used to separate columns (default: ',' - comma).

Parameters:

fieldSeparator - the field separator character.

Returns:

This updated object, so that additional method calls can be chained together.

quoteCharacter

public CsvWriter.CsvWriterBuilder quoteCharacter(char quoteCharacter)

Sets the character that is used to quote values (default: '"' - double quotes).

Parameters:

quoteCharacter - the character for enclosing fields.

Returns:

This updated object, so that additional method calls can be chained together.

commentCharacter

public CsvWriter.CsvWriterBuilder commentCharacter(char commentCharacter)

Sets the character that is used to prepend commented lines (default: '#' - hash/number).

Parameters:

commentCharacter - the character for prepending commented lines.

Returns:

This updated object, so that additional method calls can be chained together.

quoteStrategy

public CsvWriter.CsvWriterBuilder quoteStrategy(QuoteStrategy quoteStrategy)

Sets the strategy that defines when quoting has to be performed (default: QuoteStrategy.REQUIRED).

Parameters:

quoteStrategy - the strategy when fields should be enclosed using the quoteCharacter.

Returns:

This updated object, so that additional method calls can be chained together.

lineDelimiter

public CsvWriter.CsvWriterBuilder lineDelimiter(LineDelimiter lineDelimiter)

Sets the delimiter that is used to separate lines (default: LineDelimiter.CRLF).

Parameters:

lineDelimiter - the line delimiter to be used.

Returns:

This updated object, so that additional method calls can be chained together.

bufferSize

public CsvWriter.CsvWriterBuilder bufferSize(int bufferSize)

Configures the size of the internal buffer.

The default buffer size of 8,192 bytes usually does not need to be altered. One use-case is if you need many instances of a CsvWriter and need to optimize for instantiation time and memory footprint.

A buffer size of 0 disables the buffer.

Parameters:

bufferSize - the buffer size to be used (must be ≥ 0).

Returns:

This updated object, so that additional method calls can be chained together.

build

public CsvWriter build(java.io.Writer writer)

Constructs a CsvWriter for the specified Writer.

This library uses built-in buffering but writes its internal buffer to the given writer on every CsvWriter.writeRow(String...) or CsvWriter.writeRow(Iterable) call. Therefore, you probably want to pass in a BufferedWriter to retain good performance. Use build(Path, Charset, OpenOption...) for optimal performance when writing files.

Parameters:

writer - the Writer to use for writing CSV data.

Returns:

a new CsvWriter instance - never null.

Throws:

java.lang.NullPointerException - if writer is null

build

public CsvWriter build(java.nio.file.Path path,
                       java.nio.file.OpenOption... openOptions)
                throws java.io.IOException

Constructs a CsvWriter for the specified Path.

Parameters:

path - the path to write data to.

openOptions - options specifying how the file is opened. See Files.newOutputStream(Path, OpenOption...) for defaults.

Returns:

a new CsvWriter instance - never null. Don't forget to close it!

Throws:

java.io.IOException - if a write error occurs

java.lang.NullPointerException - if path or charset is null

build

public CsvWriter build(java.nio.file.Path path,
                       java.nio.charset.Charset charset,
                       java.nio.file.OpenOption... openOptions)
                throws java.io.IOException

Constructs a CsvWriter for the specified Path.

Parameters:

path - the path to write data to.

charset - the character set to be used for writing data to the file.

openOptions - options specifying how the file is opened. See Files.newOutputStream(Path, OpenOption...) for defaults.

Returns:

a new CsvWriter instance - never null. Don't forget to close it!

Throws:

java.io.IOException - if a write error occurs

java.lang.NullPointerException - if path or charset is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object