Package org.bufio

Class CsvColWriter

java.lang.Object

org.bufio.CsvColWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class CsvColWriter
extends Object
implements Closeable, Flushable

CsvColWriter provides an interface for writing CSV data by row (compatible with rfc4180 and extended with the option of having a separator other than ","). Calls to the `setX` methods can be made in any order. The `endOfRow` method tells when a line break is inserted.

 CsvColWriter w;
 CsvReader r;
 w.withColumnIndexes(r.scanHeaders(true));
 w.writerHeaders(false);
 while (r.next()) {
   w.setString(2, r.getString(1));
   w.setString(1, r.getString(2));
   ...
   w.endOfRow();
 }
 w.flush();
 

Constructor Summary

Constructors

Constructor	Description
CsvColWriter(Writer w)
CsvColWriter(Writer w, char sep, boolean quoted)

Method Summary

Modifier and Type	Method	Description
void	close()
void	endOfRow()	Tells when a line break must be inserted.
int	findColumn(String columnLabel)
void	flush()
String	getColumnLabel(int columnIndex)
void	setByte(int columnIndex, byte x)
void	setByte(String columnLabel, byte x)
void	setCommentMarker(char comment)	Sets the character marking the start of a line comment.
void	setDouble(int columnIndex, double x)
void	setDouble(String columnLabel, double x)
void	setFloat(int columnIndex, float x)
void	setFloat(String columnLabel, float x)
void	setInt(int columnIndex, int x)
void	setInt(String columnLabel, int x)
void	setLong(int columnIndex, long x)
void	setLong(String columnLabel, long x)
void	setMarshaler(Marshaler marshaler)	Sets the component called by setObject(int, java.lang.Object) to marshall value to text.
void	setObject(int columnIndex, Object x)
void	setObject(String columnLabel, Object x)
void	setShort(int columnIndex, short x)
void	setShort(String columnLabel, short x)
void	setString(int columnIndex, String x)
void	setString(String columnLabel, String x)
void	useCRLF()	Use \r\n as the line terminator.
void	withHeaders(Collection<String> headers)
void	writerHeaders(boolean useCommentMarker)

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvColWriter

public CsvColWriter(@WillCloseWhenClosed @Nonnull
                    Writer w)

CsvColWriter

public CsvColWriter(@WillCloseWhenClosed @Nonnull
                    Writer w,
                    char sep,
                    boolean quoted)

Method Detail

withHeaders

public void withHeaders(@Nonnull
                        Collection<String> headers)

findColumn

@Nonnegative
public int findColumn(String columnLabel)
               throws IllegalStateException

Throws:

IllegalStateException

See Also:

ResultSet.findColumn(String)

getColumnLabel

public String getColumnLabel(@Nonnegative
                             int columnIndex)
                      throws ScanException

Throws:

ScanException

writerHeaders

public void writerHeaders(boolean useCommentMarker)
                   throws IOException

Throws:

IllegalStateException - if no header has been specified (withHeaders(java.util.Collection<java.lang.String>)).

IOException

setString

public void setString(@Nonnegative
                      int columnIndex,
                      String x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setString

public void setString(String columnLabel,
                      String x)

setByte

public void setByte(int columnIndex,
                    byte x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setByte

public void setByte(String columnLabel,
                    byte x)

setShort

public void setShort(int columnIndex,
                     short x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setShort

public void setShort(String columnLabel,
                     short x)

setInt

public void setInt(int columnIndex,
                   int x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setInt

public void setInt(String columnLabel,
                   int x)

setLong

public void setLong(int columnIndex,
                    long x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setLong

public void setLong(String columnLabel,
                    long x)

setFloat

public void setFloat(int columnIndex,
                     float x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setFloat

public void setFloat(String columnLabel,
                     float x)

setDouble

public void setDouble(int columnIndex,
                      double x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setDouble

public void setDouble(String columnLabel,
                      double x)

setObject

public void setObject(@Nonnegative
                      int columnIndex,
                      @Nullable
                      Object x)

Parameters:

columnIndex - the first column is 1, the second is 2, ...

x - the column value

setObject

public void setObject(String columnLabel,
                      @Nullable
                      Object x)

endOfRow

public void endOfRow()
              throws IOException

Tells when a line break must be inserted.

Throws:

IOException

useCRLF

public void useCRLF()

Use \r\n as the line terminator.

setCommentMarker

public void setCommentMarker(char comment)

Sets the character marking the start of a line comment.

setMarshaler

public void setMarshaler(@Nullable
                         Marshaler marshaler)

Sets the component called by setObject(int, java.lang.Object) to marshall value to text.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException