net.talvi.puffinplot.data

Class CsvWriter

java.lang.Object

net.talvi.puffinplot.data.CsvWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

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

This class provides a wrapper around a supplied Writer to allow easy writing of lines of data with fields separated by a particular string. Despite the name of the class, any single character may be used as the separator.

Constructor Summary

Constructors

Constructor and Description
CsvWriter(java.io.Writer writer) Creates a new CSV writer which will write to the specified writer using a comma as the field separator.
CsvWriter(java.io.Writer writer, java.lang.String separator) Creates a new CSV writer which will write to the specified writer and separate fields with the specified string.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying writer supplied to this CSV writer's constructor.
void	writeCsv(java.lang.Object... objects) Writes a line to the writer provided to the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriter

public CsvWriter(java.io.Writer writer,
                 java.lang.String separator)

Creates a new CSV writer which will write to the specified writer and separate fields with the specified string.

Parameters:

writer - the writer to which to write

separator - the separator which will be placed between the fields. It must be one character long.

Throws:

java.lang.NullPointerException - if either of the arguments is null

java.lang.IllegalArgumentException - if the length of the separator is not 1

CsvWriter

public CsvWriter(java.io.Writer writer)

Creates a new CSV writer which will write to the specified writer using a comma as the field separator.

Parameters:

writer - writer the writer to which to write

Throws:

java.lang.NullPointerException - if writer is null

Method Detail

writeCsv

public void writeCsv(java.lang.Object... objects)
              throws java.io.IOException

Writes a line to the writer provided to the constructor. The line consists of strings representations of each of the provided objects, separated by the field delimiter configured for this CSV writer. If any of the supplied objects is a java.util.List, each of its members will be written as an individual field (i.e. the list will be automatically unpacked).

Parameters:

objects - the objects to write

Throws:

java.io.IOException - if an I/O error occurs during writing

close

public void close()
           throws java.io.IOException

Closes the underlying writer supplied to this CSV writer's constructor.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an I/O error occurs