zserio.runtime.json

Class JsonWriter

java.lang.Object

zserio.runtime.json.JsonWriter

All Implemented Interfaces:

java.lang.AutoCloseable, WalkObserver

public final class JsonWriter
extends java.lang.Object
implements WalkObserver, java.lang.AutoCloseable

Walker observer which dumps zserio objects to JSON format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonWriter.EnumerableFormat Configuration for writing of enumerable types.

Field Summary

Fields

Modifier and Type	Field and Description
static JsonWriter.EnumerableFormat	DEFAULT_ENUMERABLE_FORMAT Default configuration for enumerable types.
static java.lang.String	DEFAULT_ITEM_SEPARATOR Default item separator used when indent is not set (i.e.
static java.lang.String	DEFAULT_ITEM_SEPARATOR_WITH_INDENT Default item separator used when indent is not null.
static java.lang.String	DEFAULT_KEY_SEPARATOR Default key separator.

Constructor Summary

Constructors

Constructor and Description
JsonWriter(java.io.Writer out) Constructor.
JsonWriter(java.io.Writer out, int indent) Constructor.
JsonWriter(java.io.Writer out, java.lang.String indent) Constructor.

Method Summary

Modifier and Type	Method and Description
void	beginArray(java.lang.Object array, FieldInfo fieldInfo) Called at the beginning of an array.
void	beginCompound(java.lang.Object compound, FieldInfo fieldInfo, int elementIndex) Called at the beginning of an compound field object.
void	beginRoot(java.lang.Object compound) Called for the root compound zserio object which is to be walked-through.
void	close()
void	endArray(java.lang.Object array, FieldInfo fieldInfo) Called at the end of an array.
void	endCompound(java.lang.Object compound, FieldInfo fieldInfo, int elementIndex) Called at the end of just walked compound object.
void	endRoot(java.lang.Object compound) Called at the end of just walked root compound zserio object.
void	setEnumerableFormat(JsonWriter.EnumerableFormat enumerableFormat) Sets preferred formatting for enumerable types.
void	setItemSeparator(java.lang.String itemSeparator) Sets custom item separator.
void	setKeySeparator(java.lang.String keySeparator) Sets custom key separator.
void	visitValue(java.lang.Object value, FieldInfo fieldInfo, int elementIndex) Called when a simple (or an unset compound - i.e.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ITEM_SEPARATOR

public static final java.lang.String DEFAULT_ITEM_SEPARATOR

Default item separator used when indent is not set (i.e. is null).

See Also:

Constant Field Values

DEFAULT_ITEM_SEPARATOR_WITH_INDENT

public static final java.lang.String DEFAULT_ITEM_SEPARATOR_WITH_INDENT

Default item separator used when indent is not null.

See Also:

Constant Field Values

DEFAULT_KEY_SEPARATOR

public static final java.lang.String DEFAULT_KEY_SEPARATOR

Default key separator.

See Also:

Constant Field Values

DEFAULT_ENUMERABLE_FORMAT

public static final JsonWriter.EnumerableFormat DEFAULT_ENUMERABLE_FORMAT

Default configuration for enumerable types.

Constructor Detail

JsonWriter

public JsonWriter(java.io.Writer out)

Constructor.

Parameters:

out - Writer to use for writing.

JsonWriter

public JsonWriter(java.io.Writer out,
                  int indent)

Constructor.

Parameters:

out - Writer to use for writing.

indent - Indent as a number of ' ' to be used for indentation.

JsonWriter

public JsonWriter(java.io.Writer out,
                  java.lang.String indent)

Constructor.

Parameters:

out - Writer to use for writing.

indent - Indent as a string to be used for indentation.

Method Detail

setItemSeparator

public void setItemSeparator(java.lang.String itemSeparator)

Sets custom item separator. Use with caution since setting of a wrong separator can lead to invalid JSON output.

Parameters:

itemSeparator - Item separator to set.

setKeySeparator

public void setKeySeparator(java.lang.String keySeparator)

Sets custom key separator. Use with caution since setting of a wrong separator can lead to invalid JSON output.

Parameters:

keySeparator - Key separator to set.

setEnumerableFormat

public void setEnumerableFormat(JsonWriter.EnumerableFormat enumerableFormat)

Sets preferred formatting for enumerable types.

Parameters:

enumerableFormat - Enumerable format to use.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

beginRoot

public void beginRoot(java.lang.Object compound)

Description copied from interface: WalkObserver

Called for the root compound zserio object which is to be walked-through.

Specified by:

beginRoot in interface WalkObserver

Parameters:

compound - Root compound zserio object.

endRoot

public void endRoot(java.lang.Object compound)

Description copied from interface: WalkObserver

Called at the end of just walked root compound zserio object.

Specified by:

endRoot in interface WalkObserver

Parameters:

compound - Root compound zserio object.

beginArray

public void beginArray(java.lang.Object array,
                       FieldInfo fieldInfo)

Description copied from interface: WalkObserver

Called at the beginning of an array.

Specified by:

beginArray in interface WalkObserver

Parameters:

array - Zserio array.

fieldInfo - Array field info.

endArray

public void endArray(java.lang.Object array,
                     FieldInfo fieldInfo)

Description copied from interface: WalkObserver

Called at the end of an array.

Specified by:

endArray in interface WalkObserver

Parameters:

array - Zserio array.

fieldInfo - Array field info.

beginCompound

public void beginCompound(java.lang.Object compound,
                          FieldInfo fieldInfo,
                          int elementIndex)

Description copied from interface: WalkObserver

Called at the beginning of an compound field object. Note that for uninitialized compounds (i.e. null) the visit_value method is called instead!

Specified by:

beginCompound in interface WalkObserver

Parameters:

compound - Compound zserio object.

fieldInfo - Compound field info.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

endCompound

public void endCompound(java.lang.Object compound,
                        FieldInfo fieldInfo,
                        int elementIndex)

Description copied from interface: WalkObserver

Called at the end of just walked compound object.

Specified by:

endCompound in interface WalkObserver

Parameters:

compound - Compound zserio object.

fieldInfo - Compound field info.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

visitValue

public void visitValue(java.lang.Object value,
                       FieldInfo fieldInfo,
                       int elementIndex)

Description copied from interface: WalkObserver

Called when a simple (or an unset compound - i.e. None) value is reached.

Specified by:

visitValue in interface WalkObserver

Parameters:

value - Simple value.

fieldInfo - Field info of the simple value.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.