org.arp.javautil.io

Class DelimitedWriter

java.lang.Object

org.arp.javautil.io.DelimitedWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class DelimitedWriter
extends Object
implements Closeable, Flushable

Convenience class for writing delimited files.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
DelimitedWriter(char delimiter, Writer writer) Creates the writer with a column delimiter and the Writer to which to write.
DelimitedWriter(char delimiter, Writer writer, String lineSeparator) Creates the writer with a column delimiter, the Writer to which to write, and a line separator string.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Writer.
void	flush() Calls the provided Writer's Writer.flush() method.
void	newLine() Writes the provided line separator string (or the default).
void	write(String column) Writes a column, inserting a delimiter as needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedWriter

public DelimitedWriter(char delimiter,
                       Writer writer)

Creates the writer with a column delimiter and the Writer to which to write. Uses the system line separator string.

Parameters:

delimiter - a delimiter character.

writer - a Writer.

DelimitedWriter

public DelimitedWriter(char delimiter,
                       Writer writer,
                       String lineSeparator)

Creates the writer with a column delimiter, the Writer to which to write, and a line separator string.

Parameters:

delimiter - a delimiter character.

writer - a Writer. Should not be null.

lineSeparator - a line separator string. If null, the system line separator string is used.

Method Detail

write

public void write(String column)
           throws IOException

Writes a column, inserting a delimiter as needed.

Parameters:

column - the column contents.

Throws:

IOException - if an error occurs writing to the Writer.

newLine

public void newLine()
             throws IOException

Writes the provided line separator string (or the default).

Throws:

IOException - if an error occurs writing to the Writer.

close

public void close()
           throws IOException

Closes the Writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an error occurs closing the Writer.

flush

public void flush()
           throws IOException

Calls the provided Writer's Writer.flush() method.

Specified by:

flush in interface Flushable

Throws:

IOException - if an error occurs flushing the Writer.