com.thoughtworks.xstream.io.json
Class JsonWriter

java.lang.Object
  com.thoughtworks.xstream.io.AbstractWriter
      com.thoughtworks.xstream.io.json.AbstractJsonWriter
          com.thoughtworks.xstream.io.json.JsonWriter

All Implemented Interfaces:

ExtendedHierarchicalStreamWriter, HierarchicalStreamWriter

Direct Known Subclasses:

JsonHierarchicalStreamWriter

public class JsonWriter
extends AbstractJsonWriter

A simple writer that outputs JSON in a pretty-printed indented stream. Arrays, Lists and Sets rely on you NOT using XStream.addImplicitCollection(..).

Since:

1.3.1

Author:

Paul Hammant, Jörg Schaible

Nested Class Summary

static class

JsonWriter.Format Format definition for JSON.

Nested classes/interfaces inherited from class com.thoughtworks.xstream.io.json.AbstractJsonWriter

AbstractJsonWriter.Type

Field Summary

protected JsonWriter.Format	format
protected QuickWriter	writer

Fields inherited from class com.thoughtworks.xstream.io.json.AbstractJsonWriter

DROP_ROOT_MODE, EXPLICIT_MODE, STRICT_MODE

Constructor Summary

JsonWriter(Writer writer)

JsonWriter(Writer writer, char[] lineIndenter)
Deprecated. As of 1.4 use instead

JsonWriter(Writer writer, char[] lineIndenter, String newLine)
Deprecated. As of 1.4 use instead

JsonWriter(Writer writer, char[] lineIndenter, String newLine, int mode)
Deprecated. As of 1.4 use instead

JsonWriter(Writer writer, int mode)
Create a JsonWriter where the writer mode can be chosen.

JsonWriter(Writer writer, int mode, JsonWriter.Format format)
Create a JsonWriter where the writer mode can be chosen and the format definition is provided.

JsonWriter(Writer writer, int mode, JsonWriter.Format format, int bufferSize)
Create a JsonWriter.

JsonWriter(Writer writer, JsonWriter.Format format)
Create a JsonWriter where the format is provided.

JsonWriter(Writer writer, String lineIndenter)
Deprecated. As of 1.4 use instead

JsonWriter(Writer writer, String lineIndenter, String newLine)
Deprecated. As of 1.4 use instead

Method Summary

protected void	addLabel(String name) Add a label to a JSON object.
protected void	addValue(String value, AbstractJsonWriter.Type type) Add a value to a JSON object's label or to an array.
void	close() Close the writer, if necessary.
protected void	endArray() End the JSON array.
protected void	endObject() End the JSON object.
void	flush() Flush the writer, if necessary.
protected void	nextElement() Prepare a JSON object or array for another element.
protected void	startArray() Start a JSON array.
protected void	startObject() Start a JSON object.
HierarchicalStreamWriter	underlyingWriter() Return the underlying HierarchicalStreamWriter implementation.

Methods inherited from class com.thoughtworks.xstream.io.json.AbstractJsonWriter

addAttribute, endNode, isArray, setValue, startNode, startNode

Methods inherited from class com.thoughtworks.xstream.io.AbstractWriter

encodeAttribute, encodeNode

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected final QuickWriter writer

format

protected final JsonWriter.Format format

Constructor Detail

JsonWriter

public JsonWriter(Writer writer,
                  char[] lineIndenter,
                  String newLine)

Deprecated. As of 1.4 use instead

JsonWriter

public JsonWriter(Writer writer,
                  char[] lineIndenter)

Deprecated. As of 1.4 use instead

JsonWriter

public JsonWriter(Writer writer,
                  String lineIndenter,
                  String newLine)

Deprecated. As of 1.4 use instead

JsonWriter

public JsonWriter(Writer writer,
                  String lineIndenter)

Deprecated. As of 1.4 use instead

JsonWriter

public JsonWriter(Writer writer)

JsonWriter

public JsonWriter(Writer writer,
                  char[] lineIndenter,
                  String newLine,
                  int mode)

Deprecated. As of 1.4 use instead

Since:

1.3.1

JsonWriter

public JsonWriter(Writer writer,
                  int mode)

Create a JsonWriter where the writer mode can be chosen.

Parameters:

writer - the Writer where the JSON is written to

mode - the JsonWriter mode

Since:

1.3.1

See Also:

JsonWriter(Writer, int, Format)

JsonWriter

public JsonWriter(Writer writer,
                  JsonWriter.Format format)

Create a JsonWriter where the format is provided.

Parameters:

writer - the Writer where the JSON is written to

format - the JSON format definition

Since:

1.4

See Also:

JsonWriter(Writer, int, Format)

JsonWriter

public JsonWriter(Writer writer,
                  int mode,
                  JsonWriter.Format format)

Create a JsonWriter where the writer mode can be chosen and the format definition is provided.

Following constants can be used as bit mask for the mode:

• AbstractJsonWriter.DROP_ROOT_MODE: drop the root node
• AbstractJsonWriter.STRICT_MODE: do not throw ConversionException, if writer should generate invalid JSON
• AbstractJsonWriter.EXPLICIT_MODE: ensure that all available data is explicitly written even if addition objects must be added

Parameters:

writer - the Writer where the JSON is written to

mode - the JsonWriter mode

format - the JSON format definition

Since:

1.4

JsonWriter

public JsonWriter(Writer writer,
                  int mode,
                  JsonWriter.Format format,
                  int bufferSize)

Create a JsonWriter.

Parameters:

writer - the Writer where the JSON is written to

mode - the JsonWriter mode

format - the JSON format definition

bufferSize - the buffer size of the internally used QuickWriter

Since:

1.4

See Also:

JsonWriter(Writer, int, Format)

Method Detail

flush

public void flush()

Description copied from interface: HierarchicalStreamWriter

Flush the writer, if necessary.

close

public void close()

Description copied from interface: HierarchicalStreamWriter

Close the writer, if necessary.

underlyingWriter

public HierarchicalStreamWriter underlyingWriter()

Description copied from class: AbstractWriter

Return the underlying HierarchicalStreamWriter implementation.

If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).

For example:

MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT!
 mySpecificWriter.doSomethingSpecific();

MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter();  // CORRECT!
 mySpecificWriter.doSomethingSpecific();

Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.

Specified by:

underlyingWriter in interface HierarchicalStreamWriter

Overrides:

underlyingWriter in class AbstractWriter

startObject

protected void startObject()

Start a JSON object.

Specified by:

startObject in class AbstractJsonWriter

addLabel

protected void addLabel(String name)

Add a label to a JSON object.

Specified by:

addLabel in class AbstractJsonWriter

Parameters:

name - the label's name

addValue

protected void addValue(String value,
                        AbstractJsonWriter.Type type)

Add a value to a JSON object's label or to an array.

Specified by:

addValue in class AbstractJsonWriter

Parameters:

value - the value itself

type - the JSON type

startArray

protected void startArray()

Start a JSON array.

Specified by:

startArray in class AbstractJsonWriter

nextElement

protected void nextElement()

Prepare a JSON object or array for another element.

Specified by:

nextElement in class AbstractJsonWriter

endArray

protected void endArray()

End the JSON array.

Specified by:

endArray in class AbstractJsonWriter

endObject

protected void endObject()

End the JSON object.

Specified by:

endObject in class AbstractJsonWriter