de.siegmar.fastcsv.writer

Class CsvWriter

java.lang.Object

de.siegmar.fastcsv.writer.CsvWriter

public final class CsvWriter
extends java.lang.Object

This is the main class for writing CSV data.

Constructor Summary

Constructors

Constructor and Description
CsvWriter()

Method Summary

Methods

Modifier and Type	Method and Description
CsvAppender	append(java.io.File file, java.nio.charset.Charset charset) Constructs a CsvAppender for the specified File.
CsvAppender	append(java.nio.file.Path path, java.nio.charset.Charset charset) Constructs a CsvAppender for the specified Path.
CsvAppender	append(java.io.Writer writer) Constructs a CsvAppender for the specified Writer.
void	setAlwaysDelimitText(boolean alwaysDelimitText) Sets if fields should always delimited using the textDelimiter (default: false).
void	setFieldSeparator(char fieldSeparator) Sets the field separator character (default: ',' - comma).
void	setLineDelimiter(char[] lineDelimiter) Sets the line delimiter character(s) to be used (default: System.lineSeparator()).
void	setTextDelimiter(char textDelimiter) Sets the text delimiter character (default: '"' - double quotes).
void	write(java.io.File file, java.nio.charset.Charset charset, java.util.Collection<java.lang.String[]> data) Writes all specified data to the file.
void	write(java.nio.file.Path path, java.nio.charset.Charset charset, java.util.Collection<java.lang.String[]> data) Writes all specified data to the path.
void	write(java.io.Writer writer, java.util.Collection<java.lang.String[]> data) Writes all specified data to the writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriter

public CsvWriter()

Method Detail

setFieldSeparator

public void setFieldSeparator(char fieldSeparator)

Sets the field separator character (default: ',' - comma).

setTextDelimiter

public void setTextDelimiter(char textDelimiter)

Sets the text delimiter character (default: '"' - double quotes).

setAlwaysDelimitText

public void setAlwaysDelimitText(boolean alwaysDelimitText)

Sets if fields should always delimited using the textDelimiter (default: false).

setLineDelimiter

public void setLineDelimiter(char[] lineDelimiter)

Sets the line delimiter character(s) to be used (default: System.lineSeparator()).

write

public void write(java.io.File file,
         java.nio.charset.Charset charset,
         java.util.Collection<java.lang.String[]> data)
           throws java.io.IOException

Writes all specified data to the file.

Parameters:

file - where the data should be written to.

data - lines/columns to be written.

Throws:

java.io.IOException - if a write error occurs

java.lang.NullPointerException - if file, charset or data is null

write

public void write(java.nio.file.Path path,
         java.nio.charset.Charset charset,
         java.util.Collection<java.lang.String[]> data)
           throws java.io.IOException

Writes all specified data to the path.

Parameters:

path - where the data should be written to.

data - lines/columns to be written.

Throws:

java.io.IOException - if a write error occurs

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

write

public void write(java.io.Writer writer,
         java.util.Collection<java.lang.String[]> data)
           throws java.io.IOException

Writes all specified data to the writer.

Parameters:

writer - where the data should be written to.

data - lines/columns to be written.

Throws:

java.io.IOException - if a write error occurs

java.lang.NullPointerException - if writer or data is null

append

public CsvAppender append(java.io.File file,
                 java.nio.charset.Charset charset)
                   throws java.io.IOException

Constructs a CsvAppender for the specified File.

Parameters:

file - the file to write data to.

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

Returns:

a new CsvAppender instance

Throws:

java.io.IOException - if a write error occurs

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

append

public CsvAppender append(java.nio.file.Path path,
                 java.nio.charset.Charset charset)
                   throws java.io.IOException

Constructs a CsvAppender for the specified Path.

Parameters:

path - the Path (file) to write data to.

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

Returns:

a new CsvAppender instance

Throws:

java.io.IOException - if a write error occurs

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

append

public CsvAppender append(java.io.Writer writer)

Constructs a CsvAppender for the specified Writer. This library uses built-in buffering, so you do not need to pass in a buffered Writer implementation such as BufferedWriter. Performance may be even likely better if you do not.

Parameters:

writer - the Writer to use for writing CSV data.

Returns:

a new CsvAppender instance

Throws:

java.lang.NullPointerException - if writer is null