Package org.apache.juneau.csv

Class CsvWriter

java.lang.Object

java.io.Writer

org.apache.juneau.serializer.SerializerWriter

org.apache.juneau.csv.CsvWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CsvWriter
extends SerializerWriter

Specialized writer for serializing CSV.

Notes:

• This class is not intended for external use.

Field Summary

Fields inherited from class org.apache.juneau.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
CsvWriter	append(char c)
CsvWriter	append(int indent, char c)	Writes an indent (if the useWhitespace setting is enabled), followed by text.
CsvWriter	append(int indent, String text)	Writes an indent (if the useWhitespace setting is enabled), followed by text.
CsvWriter	append(Object text)	Writes the specified text to the writer if it isn't null.
CsvWriter	append(String text)	Writes the specified text to the writer if it isn't null.
CsvWriter	appendIf(boolean b, char c)	Writes the specified text to the writer if b is true.
CsvWriter	appendIf(boolean b, String text)	Writes the specified text to the writer if b is true.
CsvWriter	appendln(int indent, String text)	Writes an indent (if the useWhitespace setting is enabled), followed by text, followed by a newline (if the useWhitespace setting is enabled).
CsvWriter	appendln(String text)	Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
CsvWriter	i(int indent)	Writes an indent to the writer if the useWhitespace setting is enabled.
CsvWriter	nl(int indent)	Writes a newline to the writer if the useWhitespace setting is enabled.
CsvWriter	q()	Adds the quote character specified by the quoteChar setting to the output.
CsvWriter	s()	Adds a whitespace character to the output if the useWhitespace setting is enabled.
void	writeEntry(Object value)	Writes an entry to the writer.

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

append, appendUri, close, cr, cre, flush, ie, nlIf, 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.

Parameters:

value - The value to write.

appendln

public CsvWriter appendln(int indent,
 String text)

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text, followed by a newline (if the useWhitespace setting is enabled).

Overrides:

appendln in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

text - The text to write.

Returns:

This object.

appendln

public CsvWriter appendln(String text)

Description copied from class: SerializerWriter

Writes the specified text followed by a newline (if the useWhitespace setting is enabled).

Overrides:

appendln in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object.

append

public CsvWriter append(int indent,
 String text)

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text.

Overrides:

append in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

text - The text to write.

Returns:

This object.

append

public CsvWriter append(int indent,
 char c)

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text.

Overrides:

append in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

c - The character to write.

Returns:

This object.

s

public CsvWriter s()

Description copied from class: SerializerWriter

Adds a whitespace character to the output if the useWhitespace setting is enabled.

Overrides:

s in class SerializerWriter

Returns:

This object.

q

public CsvWriter q()

Description copied from class: SerializerWriter

Adds the quote character specified by the quoteChar setting to the output.

Overrides:

q in class SerializerWriter

Returns:

This object.

i

public CsvWriter i(int indent)

Description copied from class: SerializerWriter

Writes an indent to the writer if the useWhitespace setting is enabled.

Overrides:

i in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

Returns:

This object.

nl

public CsvWriter nl(int indent)

Description copied from class: SerializerWriter

Writes a newline to the writer if the useWhitespace setting is enabled.

Overrides:

nl in class SerializerWriter

Parameters:

indent - The current indentation level.

Returns:

This object.

append

public CsvWriter append(Object text)

Description copied from class: SerializerWriter

Writes the specified text to the writer if it isn't null.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object.

append

public CsvWriter append(String text)

Description copied from class: SerializerWriter

Writes the specified text to the writer if it isn't null.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object.

appendIf

public CsvWriter appendIf(boolean b,
 String text)

Description copied from class: SerializerWriter

Writes the specified text to the writer if b is true.

Overrides:

appendIf in class SerializerWriter

Parameters:

b - Boolean flag.

text - The text to write.

Returns:

This object.

appendIf

public CsvWriter appendIf(boolean b,
 char c)

Description copied from class: SerializerWriter

Writes the specified text to the writer if b is true.

Overrides:

appendIf in class SerializerWriter

Parameters:

b - Boolean flag.

c - The text to write.

Returns:

This object.

append

public CsvWriter append(char c)

Specified by:

append in interface Appendable

Overrides:

append in class SerializerWriter