org.apache.juneau.uon

Class UonWriter

java.lang.Object

java.io.Writer

org.apache.juneau.serializer.SerializerWriter

org.apache.juneau.uon.UonWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public final class UonWriter
extends SerializerWriter

Specialized writer for serializing UON-encoded text.

• 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 and Description
protected	UonWriter(UonSerializerSession session, Writer out, boolean useWhitespace, int maxIndent, boolean encodeChars, boolean trimStrings, boolean plainTextParams, UriResolver uriResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
UonWriter	append(char c)
UonWriter	append(int indent, char c) Writes an indent (if the useWhitespace setting is enabled), followed by text.
UonWriter	append(int indent, String text) Writes an indent (if the useWhitespace setting is enabled), followed by text.
UonWriter	append(Object text) Writes the specified text to the writer.
UonWriter	append(String text) Writes the specified text to the writer.
protected UonWriter	appendBoolean(Object o) Appends a boolean value to the output.
UonWriter	appendIf(boolean b, char c) Writes the specified text to the writer if b is true.
UonWriter	appendIf(boolean b, String text) Writes the specified text to the writer if b is true.
UonWriter	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).
UonWriter	appendln(String text) Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
protected UonWriter	appendNumber(Object o) Appends a numeric value to the output.
UonWriter	appendObject(Object o, boolean isTopAttrName) Serializes the specified simple object as a UON string value.
SerializerWriter	appendUri(Object uri) Appends a URI to the output.
UonWriter	cr(int depth) Performs a carriage return.
UonWriter	cre(int depth) Performs a carriage return at the end of a line.
UonWriter	i(int indent) Writes an indent to the writer if the useWhitespace setting is enabled.
UonWriter	nl(int indent) Writes a newline to the writer if the useWhitespace setting is enabled.
UonWriter	q() Adds the quote character specified by the quoteChar setting to the output.

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

append, close, flush, ie, nlIf, s, sIf, write

Methods inherited from class java.io.Writer

append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

UonWriter

protected UonWriter(UonSerializerSession session,
                    Writer out,
                    boolean useWhitespace,
                    int maxIndent,
                    boolean encodeChars,
                    boolean trimStrings,
                    boolean plainTextParams,
                    UriResolver uriResolver)

Constructor.

Parameters:

session - The session that created this writer.

out - The writer being wrapped.

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

maxIndent - The maximum indentation level.

encodeChars - If true, special characters should be encoded.

trimStrings - If true, strings should be trimmed before they're serialized.

plainTextParams - If true, don't use UON notation for values.

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

Method Detail

appendObject

public final UonWriter appendObject(Object o,
                                    boolean isTopAttrName)
                             throws IOException

Serializes the specified simple object as a UON string value.

Parameters:

o - The object being serialized.

isTopAttrName - If this is a top-level attribute name we're serializing.

Returns:

This object (for method chaining).

Throws:

IOException - Should never happen.

appendBoolean

protected UonWriter appendBoolean(Object o)
                           throws IOException

Appends a boolean value to the output.

Parameters:

o - The boolean value to append to the output.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

appendNumber

protected UonWriter appendNumber(Object o)
                          throws IOException

Appends a numeric value to the output.

Parameters:

o - The numeric value to append to the output.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

appendUri

public SerializerWriter appendUri(Object uri)
                           throws IOException

Appends a URI to the output.

Overrides:

appendUri in class SerializerWriter

Parameters:

uri - The URI to append to the output.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

cr

public UonWriter cr(int depth)
             throws IOException

Description copied from class: SerializerWriter

Performs a carriage return.

Adds a newline and the specified number of tabs (if the useWhitespace setting is enabled) to the output.

Overrides:

cr in class SerializerWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

cre

public UonWriter cre(int depth)
              throws IOException

Description copied from class: SerializerWriter

Performs a carriage return at the end of a line.

Adds a newline and the specified number of tabs (if the useWhitespace setting is enabled) to the output.

Overrides:

cre in class SerializerWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

appendln

public UonWriter appendln(int indent,
                          String text)
                   throws IOException

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.

Throws:

IOException - If a problem occurred trying to write to the writer.

appendln

public UonWriter appendln(String text)
                   throws IOException

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.

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public UonWriter append(int indent,
                        String text)
                 throws IOException

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.

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public UonWriter append(int indent,
                        char c)
                 throws IOException

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.

Throws:

IOException - If a problem occurred trying to write to the writer.

q

public UonWriter q()
            throws IOException

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 (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

i

public UonWriter i(int indent)
            throws IOException

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 (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

nl

public UonWriter nl(int indent)
             throws IOException

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 (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public UonWriter append(Object text)
                 throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public UonWriter append(String text)
                 throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

appendIf

public UonWriter appendIf(boolean b,
                          String text)
                   throws IOException

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 (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

appendIf

public UonWriter appendIf(boolean b,
                          char c)
                   throws IOException

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 (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public UonWriter append(char c)
                 throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class SerializerWriter

Throws:

IOException