org.apache.juneau.json

Class JsonWriter

java.lang.Object

java.io.Writer

org.apache.juneau.serializer.SerializerWriter

org.apache.juneau.json.JsonWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public final class JsonWriter
extends SerializerWriter

Specialized writer for serializing JSON.

• 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	JsonWriter(Writer out, boolean useWhitespace, int maxIndent, boolean escapeSolidus, char quoteChar, boolean simpleMode, boolean trimStrings, UriResolver uriResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
JsonWriter	append(char c)
JsonWriter	append(int indent, char c) Writes an indent (if the useWhitespace setting is enabled), followed by text.
JsonWriter	append(int indent, String text) Writes an indent (if the useWhitespace setting is enabled), followed by text.
JsonWriter	append(Object text) Writes the specified text to the writer.
JsonWriter	append(String text) Writes the specified text to the writer.
JsonWriter	appendIf(boolean b, char c) Writes the specified text to the writer if b is true.
JsonWriter	appendIf(boolean b, String text) Writes the specified text to the writer if b is true.
JsonWriter	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).
JsonWriter	appendln(String text) Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
JsonWriter	attr(String s) Serializes the specified object as a JSON attribute name.
JsonWriter	cr(int depth) Performs a carriage return.
JsonWriter	cre(int depth) Performs a carriage return at the end of a line.
JsonWriter	i(int indent) Writes an indent to the writer if the useWhitespace setting is enabled.
JsonWriter	nl(int indent) Writes a newline to the writer if the useWhitespace setting is enabled.
JsonWriter	q() Adds the quote character specified by the quoteChar setting to the output.
JsonWriter	s() Adds a whitespace character to the output if the useWhitespace setting is enabled.
JsonWriter	s(int indent) Adds a space only if the current indentation level is below maxIndent.
JsonWriter	smi(int depth) Performs an indentation only if we're currently past max indentation.
JsonWriter	stringValue(String s) Serializes the specified object as a JSON string value.
SerializerWriter	uriValue(Object uri) Appends a URI to the output.

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

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

JsonWriter

protected JsonWriter(Writer out,
                     boolean useWhitespace,
                     int maxIndent,
                     boolean escapeSolidus,
                     char quoteChar,
                     boolean simpleMode,
                     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.

escapeSolidus - If true, forward slashes should be escaped in the output.

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

simpleMode - If true, JSON attributes will only be quoted when necessary.

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

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

Method Detail

stringValue

public JsonWriter stringValue(String s)
                       throws IOException

Serializes the specified object as a JSON string value.

Parameters:

s - The object being serialized.

Returns:

This object (for method chaining).

Throws:

IOException - Should never happen.

attr

public JsonWriter attr(String s)
                throws IOException

Serializes the specified object as a JSON attribute name.

Parameters:

s - The object being serialized.

Returns:

This object (for method chaining).

Throws:

IOException - Should never happen.

uriValue

public SerializerWriter uriValue(Object uri)
                          throws IOException

Appends a URI to the output.

Parameters:

uri - The URI to append to the output.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

cr

public JsonWriter 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 JsonWriter 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.

smi

public JsonWriter smi(int depth)
               throws IOException

Performs an indentation only if we're currently past max indentation.

Parameters:

depth - The current indentation depth.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

appendln

public JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter 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.

s

public JsonWriter s()
             throws IOException

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

Throws:

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

s

public JsonWriter s(int indent)
             throws IOException

Adds a space only if the current indentation level is below maxIndent.

Parameters:

indent - The number of spaces to indent.

Returns:

This object (for method chaining).

Throws:

IOException - Thrown by underlying stream.

q

public JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter 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 JsonWriter append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class SerializerWriter

Throws:

IOException