org.pfsw.text.json

Class JsonWriter

java.lang.Object

org.pfsw.text.json.JsonWriter

public class JsonWriter
extends java.lang.Object

Writes a given JsonObject into an Appendable using JSON string representation format.

This class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JsonWriter.FieldData

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENTATION_SPACES
static boolean	DEFAULT_OPEN_BRACES_ON_NEW_LINE

Constructor Summary

Constructors

Constructor and Description
JsonWriter() Creates a new instance with opening braces '{' and '[' on the same line and 2 indentation spaces per indentation level.
JsonWriter(boolean openingBracesOnNewLine) Creates a new instance with a default of 2 indentation spaces per indentation level.
JsonWriter(int indentationSpaces) Creates a new instance with opening braces '{' and '[' on the same line and the specified indentation spaces per indentation level.
JsonWriter(int indentationSpaces, boolean openingBracesOnNewLine) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	asString(JsonObject jsonObject) Convenience method to convert the given JsonObject to a pretty printed JSON string representation.
static JsonWriter	create() Creates a new instance with opening braces '{' and '[' on the same line.
static JsonWriter	create(int indentationSpaces) Creates a new instance with opening braces '{' and '[' on the same line and the specified indentation spaces per indentation level.
protected FormattedTextWriter	createFormattedTextWriterFor(java.lang.Appendable target)
static JsonWriter	createWithOpeningBracesOnNewLine() Creates a new instance with opening braces '{' and '[' on a new line.
static JsonWriter	createWithOpeningBracesOnNewLine(int indentationSpaces) Creates a new instance with opening braces '{' and '[' on a new line.
int	getIndentationSpaces() Returns how many spaces per indentation level will be used for formatting.
boolean	isOpeningBracesOnNewLine() Returns true if opening braces like '{' and '[' are put on a new line.
static java.lang.String	prettyPrint(JsonObject jsonObject) Convenience method to convert the given JsonObject to a pretty printed JSON string representation (with opening braces on same line and 2 spaces indentation).
void	write(java.lang.Appendable target, JsonObject jsonObject) Writes the given JsonObject to the specified Appendable with line breaks and indentation.
protected void	writeArrayEnd(FormattedTextWriter writer)
protected void	writeArrayStart(FormattedTextWriter writer)
protected void	writeField(FormattedTextWriter writer, JsonWriter.FieldData field)
protected void	writeJsonObject(FormattedTextWriter writer, JsonObject jsonObject)
protected void	writeJsonObjectFields(FormattedTextWriter writer, JsonObject jsonObject)
protected void	writeMultipleValues(FormattedTextWriter writer, java.util.Collection<?> valueCollection)
protected void	writeObjectEnd(FormattedTextWriter writer)
protected void	writeObjectStart(FormattedTextWriter writer)
protected void	writeStart(FormattedTextWriter writer, JsonSyntaxElement startElement)
protected void	writeValue(FormattedTextWriter writer, java.lang.Object value, boolean isSingleValue)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPEN_BRACES_ON_NEW_LINE

public static final boolean DEFAULT_OPEN_BRACES_ON_NEW_LINE

See Also:

Constant Field Values

DEFAULT_INDENTATION_SPACES

public static final int DEFAULT_INDENTATION_SPACES

See Also:

Constant Field Values

Constructor Detail

JsonWriter

public JsonWriter()

Creates a new instance with opening braces '{' and '[' on the same line and 2 indentation spaces per indentation level.

JsonWriter

public JsonWriter(boolean openingBracesOnNewLine)

Creates a new instance with a default of 2 indentation spaces per indentation level.

Parameters:

openingBracesOnNewLine - Defines whether or not opening braces '{' and '[' must be put on new line.

JsonWriter

public JsonWriter(int indentationSpaces)

Creates a new instance with opening braces '{' and '[' on the same line and the specified indentation spaces per indentation level.

Parameters:

indentationSpaces - The number of spaces per indentation level.

Throws:

java.lang.IllegalArgumentException - if the given indentation size is less than 0 or greater than 20.

JsonWriter

public JsonWriter(int indentationSpaces,
                  boolean openingBracesOnNewLine)

Creates a new instance.

Parameters:

indentationSpaces - The number of spaces per indentation level.

openingBracesOnNewLine - Defines whether or not opening braces '{' and '[' must be put on new line.

Throws:

java.lang.IllegalArgumentException - if the given indentation size is less than 0 or greater than 20.

Method Detail

create

public static JsonWriter create()

Creates a new instance with opening braces '{' and '[' on the same line.

Returns:

The created instance.

createWithOpeningBracesOnNewLine

public static JsonWriter createWithOpeningBracesOnNewLine()

Creates a new instance with opening braces '{' and '[' on a new line.

Returns:

The created instance.

create

public static JsonWriter create(int indentationSpaces)

Creates a new instance with opening braces '{' and '[' on the same line and the specified indentation spaces per indentation level.

Parameters:

indentationSpaces - The number of spaces per indentation level.

Returns:

The created instance.

Throws:

java.lang.IllegalArgumentException - if the given indentation size is less than 0 or greater than 20.

createWithOpeningBracesOnNewLine

public static JsonWriter createWithOpeningBracesOnNewLine(int indentationSpaces)

Creates a new instance with opening braces '{' and '[' on a new line.

Parameters:

indentationSpaces - The number of spaces per indentation level.

Returns:

The created instance.

Throws:

java.lang.IllegalArgumentException - if the given indentation size is less than 0 or greater than 20.

prettyPrint

public static java.lang.String prettyPrint(JsonObject jsonObject)

Convenience method to convert the given JsonObject to a pretty printed JSON string representation (with opening braces on same line and 2 spaces indentation).

Parameters:

jsonObject - The JSON object to convert to a pretty string.

Returns:

The pretty string JSON representation.

asString

public java.lang.String asString(JsonObject jsonObject)

Convenience method to convert the given JsonObject to a pretty printed JSON string representation.

Parameters:

jsonObject - The JSON object to be converted to a string.

Returns:

The JSON string representation.

write

public void write(java.lang.Appendable target,
                  JsonObject jsonObject)

Writes the given JsonObject to the specified Appendable with line breaks and indentation.

Parameters:

target - The target to which write the output.

jsonObject - The object to be written as JSON string representation.

writeField

protected void writeField(FormattedTextWriter writer,
                          JsonWriter.FieldData field)

writeValue

protected void writeValue(FormattedTextWriter writer,
                          java.lang.Object value,
                          boolean isSingleValue)

writeJsonObject

protected void writeJsonObject(FormattedTextWriter writer,
                               JsonObject jsonObject)

writeJsonObjectFields

protected void writeJsonObjectFields(FormattedTextWriter writer,
                                     JsonObject jsonObject)

writeMultipleValues

protected void writeMultipleValues(FormattedTextWriter writer,
                                   java.util.Collection<?> valueCollection)

writeObjectStart

protected void writeObjectStart(FormattedTextWriter writer)

writeObjectEnd

protected void writeObjectEnd(FormattedTextWriter writer)

writeArrayStart

protected void writeArrayStart(FormattedTextWriter writer)

writeArrayEnd

protected void writeArrayEnd(FormattedTextWriter writer)

writeStart

protected void writeStart(FormattedTextWriter writer,
                          JsonSyntaxElement startElement)

getIndentationSpaces

public int getIndentationSpaces()

Returns how many spaces per indentation level will be used for formatting.

isOpeningBracesOnNewLine

public boolean isOpeningBracesOnNewLine()

Returns true if opening braces like '{' and '[' are put on a new line.

createFormattedTextWriterFor

protected FormattedTextWriter createFormattedTextWriterFor(java.lang.Appendable target)