de.siegmar.fastcsv.writer

Class CsvWriter

java.lang.Object

de.siegmar.fastcsv.writer.CsvWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class CsvWriter
extends java.lang.Object
implements java.io.Closeable

This is the main class for writing CSV data.

Example use:

 try (CsvWriter csv = CsvWriter.builder().build(path)) {
     csv.writeRow("Hello", "world");
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CsvWriter.CsvWriterBuilder This builder is used to create configured instances of CsvWriter.

Method Summary

Modifier and Type	Method and Description
static CsvWriter.CsvWriterBuilder	builder() Creates a CsvWriter.CsvWriterBuilder instance used to configure and create instances of this class.
void	close()
java.lang.String	toString()
CsvWriter	writeComment(java.lang.String comment) Writes a comment line and new line character(s) at the end.
CsvWriter	writeRow(java.lang.Iterable<java.lang.String> values) Writes a complete line - one or more fields and new line character(s) at the end.
CsvWriter	writeRow(java.lang.String... values) Writes a complete line - one or more fields and new line character(s) at the end.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CsvWriter.CsvWriterBuilder builder()

Creates a CsvWriter.CsvWriterBuilder instance used to configure and create instances of this class.

Returns:

CsvWriterBuilder instance with default settings.

writeRow

public CsvWriter writeRow(java.lang.Iterable<java.lang.String> values)

Writes a complete line - one or more fields and new line character(s) at the end.

Parameters:

values - the fields to write (null values are handled as empty strings, if not configured otherwise (QuoteStrategy.EMPTY)).

Returns:

This CsvWriter.

Throws:

java.io.UncheckedIOException - if a write error occurs

See Also:

writeRow(String...)

writeRow

public CsvWriter writeRow(java.lang.String... values)

Writes a complete line - one or more fields and new line character(s) at the end.

Parameters:

values - the fields to write (null values are handled as empty strings, if not configured otherwise (QuoteStrategy.EMPTY))

Returns:

This CsvWriter.

Throws:

java.io.UncheckedIOException - if a write error occurs

See Also:

writeRow(Iterable)

writeComment

public CsvWriter writeComment(java.lang.String comment)

Writes a comment line and new line character(s) at the end.

Parameters:

comment - the comment to write. The comment character (configured by CsvWriter.CsvWriterBuilder.commentCharacter(char)) is automatically prepended. Empty or null values results in a line only consisting of the comment character. If the argument comment contains line break characters (CR, LF), multiple comment lines will be written, terminated with the line break character configured by CsvWriter.CsvWriterBuilder.lineDelimiter(LineDelimiter).

Returns:

This CsvWriter.

Throws:

java.io.UncheckedIOException - if a write error occurs

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object