Package org.apache.juneau.marshall.csv

Class CsvWriter

java.lang.Object

java.io.Writer

org.apache.juneau.marshall.serializer.SerializerWriter<CsvWriter>

org.apache.juneau.marshall.csv.CsvWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CsvWriter
extends SerializerWriter<CsvWriter>

Specialized writer for serializing CSV.

Notes:

• This class is not intended for external use.

Field Summary

Fields inherited from class org.apache.juneau.marshall.serializer.SerializerWriter

maxIndent, out, quoteChar, trimStrings, uriResolver, useWhitespace

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CsvWriter(Writer out, boolean useWhitespace, int maxIndent, char quoteChar, boolean trimStrings, UriResolver uriResolver)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	writeEntry(Object value)	Writes an entry to the writer.

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerWriter

append, append, append, append, append, append, appendIf, appendIf, appendln, appendln, appendUri, close, cr, cre, flush, i, ie, nl, nlIf, q, s, self, sIf, w, w, write

Methods inherited from class java.io.Writer

append, append, nullWriter, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

CsvWriter

protected CsvWriter(Writer out,
 boolean useWhitespace,
 int maxIndent,
 char quoteChar,
 boolean trimStrings,
 UriResolver uriResolver)

Constructor.

Parameters:

out - The writer being wrapped.

useWhitespace - If true, tabs and spaces will be used in output.

maxIndent - The maximum indentation level.

quoteChar - The quote character to use (i.e. '\'' or '"')

trimStrings - If true, strings will be trimmed before being serialized.

uriResolver - The URI resolver for resolving URIs to absolute or root-relative form.

Method Details

writeEntry

public void writeEntry(Object value)

Writes an entry to the writer.

Follows RFC 4180 quoting rules:

• Values containing commas, double-quote characters, or newlines are enclosed in double quotes.
• Double-quote characters within a quoted field are escaped by preceding them with another double-quote.
• The literal string null is written unquoted; the string value "null" is quoted.

Parameters:

value - The value to write.
Can be null (written as the literal "null").