info.unterrainer.java.tools.csvtools

Class CsvWriter

java.lang.Object

info.unterrainer.java.tools.csvtools.CsvBase

info.unterrainer.java.tools.csvtools.CsvWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class CsvWriter
extends CsvBase

This data-structure represents a comma-separated-values file. It helps in dealing with such files and delivers various manipulation routines.

Field Summary

Fields inherited from class info.unterrainer.java.tools.csvtools.CsvBase

columnSeparator, DEFAULT_COLUMN_SEPARATOR, DEFAULT_FIELD_DELIMITER, DEFAULT_ROW_SEPARATOR, fieldDelimiter, lockObject, rowSeparator

Constructor Summary

Constructors

Constructor and Description
CsvWriter(@Nullable StringWriter stringWriter) Initializes a new instance of the CsvWriter class.
CsvWriter(@Nullable StringWriter stringWriter, @Nullable Character columnSeparator, @Nullable String rowSeparator, @Nullable String fieldDelimiter, @Nullable Integer writeChunkSize, @Nullable QuotingBehavior quotingBehavior) Initializes a new instance of the CsvWriter class.
CsvWriter(@Nullable StringWriter stringWriter, char columnSeparator, String rowSeparator, String fieldDelimiter) Initializes a new instance of the CsvWriter class.
CsvWriter(@Nullable StringWriter stringWriter, char columnSeparator, String rowSeparator, String fieldDelimiter, int writeChunkSize) Initializes a new instance of the CsvWriter class.
CsvWriter(StringWriter stringWriter, char columnSeparator, String rowSeparator, String fieldDelimiter, QuotingBehavior quotingBehavior) Initializes a new instance of the CsvWriter class.
CsvWriter(StringWriter stringWriter, QuotingBehavior quotingBehavior) Initializes a new instance of the CsvWriter class.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
CsvWriter	flush() Flushes all internal buffers to the underlying writer.
CsvWriter	flushUnderlyingWriter() Calls flush on the underlying stringWriter.
CsvWriter	write() Writes an empty string (followed by a column-separator).
CsvWriter	write(@Nullable List<String> csvData) Writes a row to the CSV not ending with a rowSeparator.
CsvWriter	write(@Nullable String csvData) Writes a field to the CSV and appends a columnSeparator in front of the new entry if necessary.
CsvWriter	writeAll(@Nullable List<List<String>> csvData) Writes all rows to a CSV.
CsvWriter	writeLine() Writes a row-separator, advancing the writer to a new row.
CsvWriter	writeLine(@Nullable List<String> csvData) Writes a row to the CSV ending with a rowSeparator.
CsvWriter	writeLine(@Nullable String csvData) Writes a field to the CSV and appends a columnSeparator in front of the new entry if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriter

public CsvWriter(@Nullable
                 @Nullable StringWriter stringWriter)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

CsvWriter

public CsvWriter(StringWriter stringWriter,
                 QuotingBehavior quotingBehavior)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

quotingBehavior - The quotingBehavior tells the writer how to quote fields in the resulting CSV. Minimal only lets him apply quotes where absolutely necessary. All means that he always applies them, necessary or not.

CsvWriter

public CsvWriter(@Nullable
                 @Nullable StringWriter stringWriter,
                 char columnSeparator,
                 String rowSeparator,
                 String fieldDelimiter)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

CsvWriter

public CsvWriter(StringWriter stringWriter,
                 char columnSeparator,
                 String rowSeparator,
                 String fieldDelimiter,
                 QuotingBehavior quotingBehavior)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

quotingBehavior - The quotingBehavior tells the writer how to quote fields in the resulting CSV. Minimal only lets him apply quotes where absolutely necessary. All means that he always applies them, necessary or not.

CsvWriter

public CsvWriter(@Nullable
                 @Nullable StringWriter stringWriter,
                 char columnSeparator,
                 String rowSeparator,
                 String fieldDelimiter,
                 int writeChunkSize)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

writeChunkSize - Size of one chunk (the minimal value is rowSeparator.length() and is automatically assigned if the given value was too small). The bufferSize is automatically allocated in any case. It will be readChunkSize + rowSeparator.length() due to the parsing technique used).

CsvWriter

public CsvWriter(@Nullable
                 @Nullable StringWriter stringWriter,
                 @Nullable
                 @Nullable Character columnSeparator,
                 @Nullable
                 @Nullable String rowSeparator,
                 @Nullable
                 @Nullable String fieldDelimiter,
                 @Nullable
                 @Nullable Integer writeChunkSize,
                 @Nullable
                 @Nullable QuotingBehavior quotingBehavior)

Initializes a new instance of the CsvWriter class. Call close() on it before moving on in order to flush and close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringWriter - The StringWriter you want the CsvWriter to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

writeChunkSize - Size of one chunk (the minimal value is rowSeparator.length() and is automatically assigned if the given value was too small). The bufferSize is automatically allocated in any case. It will be readChunkSize + rowSeparator.length() due to the parsing technique used).

quotingBehavior - The quotingBehavior tells the writer how to quote fields in the resulting CSV. Minimal only lets him apply quotes where absolutely necessary. All means that he always applies them, necessary or not.

Method Detail

flush

public CsvWriter flush()
                throws IOException

Flushes all internal buffers to the underlying writer.

Throws:

IOException - If the underlying stream could not be accessed.

flushUnderlyingWriter

public CsvWriter flushUnderlyingWriter()
                                throws IOException

Calls flush on the underlying stringWriter.

Throws:

IOException - If the underlying stream could not be accessed.

write

public CsvWriter write()
                throws IOException

Writes an empty string (followed by a column-separator).

Throws:

IOException - If the underlying stream could not be accessed.

writeLine

public CsvWriter writeLine()
                    throws IOException

Writes a row-separator, advancing the writer to a new row. Does not write an empty string before advancing the writer.

Throws:

IOException - If the underlying stream could not be accessed.

writeLine

public CsvWriter writeLine(@Nullable
                           @Nullable String csvData)
                    throws IOException

Writes a field to the CSV and appends a columnSeparator in front of the new entry if necessary. Appends a rowSeparator at the end, advancing the writer to a new row.

Parameters:

csvData - The data that should be written.

Throws:

IOException - If the underlying stream could not be accessed.

write

public CsvWriter write(@Nullable
                       @Nullable String csvData)
                throws IOException

Writes a field to the CSV and appends a columnSeparator in front of the new entry if necessary.

Parameters:

csvData - The data, that should be written to the CSV.

Throws:

IOException - If the underlying stream could not be accessed.

writeLine

public CsvWriter writeLine(@Nullable
                           @Nullable List<String> csvData)
                    throws IOException

Writes a row to the CSV ending with a rowSeparator. Treats the target as if it was empty, or at least in a new-row-position (empty row, no field inserted yet).

Parameters:

csvData - The data, that should be written to the CSV.

Throws:

IOException - If the underlying stream could not be accessed.

write

public CsvWriter write(@Nullable
                       @Nullable List<String> csvData)
                throws IOException

Writes a row to the CSV not ending with a rowSeparator. Treats the target as if it was empty, or at least in a newline-position (empty row, no field inserted yet).

Parameters:

csvData - The data, that should be written to the CSV.

Throws:

IOException - If the underlying stream could not be accessed.

writeAll

public CsvWriter writeAll(@Nullable
                          @Nullable List<List<String>> csvData)
                   throws IOException

Writes all rows to a CSV. Treats the target as if it was empty, or at least in a newline-position (empty row, no field inserted yet).

Parameters:

csvData - The data, that should be written to the CSV.

Throws:

IOException - If the underlying stream could not be accessed.

close

public void close()
           throws IOException

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable