com.thoughtworks.xstream.io.json
Class JsonHierarchicalStreamWriter

java.lang.Object
  extended by com.thoughtworks.xstream.io.json.JsonHierarchicalStreamWriter
All Implemented Interfaces:
ExtendedHierarchicalStreamWriter, HierarchicalStreamWriter

public class JsonHierarchicalStreamWriter
extends java.lang.Object
implements ExtendedHierarchicalStreamWriter

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.2
Author:
Paul Hammant

Nested Class Summary
 class JsonHierarchicalStreamWriter.Node
           
 
Constructor Summary
JsonHierarchicalStreamWriter(java.io.Writer writer)
           
JsonHierarchicalStreamWriter(java.io.Writer writer, char[] lineIndenter)
           
JsonHierarchicalStreamWriter(java.io.Writer writer, char[] lineIndenter, java.lang.String newLine)
           
JsonHierarchicalStreamWriter(java.io.Writer writer, java.lang.String lineIndenter)
           
JsonHierarchicalStreamWriter(java.io.Writer writer, java.lang.String lineIndenter, java.lang.String newLine)
           
 
Method Summary
 void addAttribute(java.lang.String key, java.lang.String value)
           
 void close()
          Close the writer, if necessary.
 void endNode()
           
protected  void endOfLine()
           
 void flush()
          Flush the writer, if necessary.
 void setValue(java.lang.String text)
          Write the value (text content) of the current node.
 void startNode(java.lang.String name)
          Deprecated. Use startNode(String name, Class clazz) instead.
 void startNode(java.lang.String name, java.lang.Class clazz)
           
 HierarchicalStreamWriter underlyingWriter()
          Return the underlying HierarchicalStreamWriter implementation.
protected  void writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter writer, java.lang.String text)
           
protected  void writeText(com.thoughtworks.xstream.core.util.QuickWriter writer, java.lang.String text)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JsonHierarchicalStreamWriter

public JsonHierarchicalStreamWriter(java.io.Writer writer,
                                    char[] lineIndenter,
                                    java.lang.String newLine)

JsonHierarchicalStreamWriter

public JsonHierarchicalStreamWriter(java.io.Writer writer,
                                    char[] lineIndenter)

JsonHierarchicalStreamWriter

public JsonHierarchicalStreamWriter(java.io.Writer writer,
                                    java.lang.String lineIndenter,
                                    java.lang.String newLine)

JsonHierarchicalStreamWriter

public JsonHierarchicalStreamWriter(java.io.Writer writer,
                                    java.lang.String lineIndenter)

JsonHierarchicalStreamWriter

public JsonHierarchicalStreamWriter(java.io.Writer writer)
Method Detail

startNode

public void startNode(java.lang.String name)
Deprecated. Use startNode(String name, Class clazz) instead.

Specified by:
startNode in interface HierarchicalStreamWriter

startNode

public void startNode(java.lang.String name,
                      java.lang.Class clazz)
Specified by:
startNode in interface ExtendedHierarchicalStreamWriter

setValue

public void setValue(java.lang.String text)
Description copied from interface: HierarchicalStreamWriter
Write the value (text content) of the current node.

Specified by:
setValue in interface HierarchicalStreamWriter

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.String value)
Specified by:
addAttribute in interface HierarchicalStreamWriter

writeAttributeValue

protected void writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter writer,
                                   java.lang.String text)

writeText

protected void writeText(com.thoughtworks.xstream.core.util.QuickWriter writer,
                         java.lang.String text)

endNode

public void endNode()
Specified by:
endNode in interface HierarchicalStreamWriter

endOfLine

protected void endOfLine()

flush

public void flush()
Description copied from interface: HierarchicalStreamWriter
Flush the writer, if necessary.

Specified by:
flush in interface HierarchicalStreamWriter

close

public void close()
Description copied from interface: HierarchicalStreamWriter
Close the writer, if necessary.

Specified by:
close in interface HierarchicalStreamWriter

underlyingWriter

public HierarchicalStreamWriter underlyingWriter()
Description copied from interface: HierarchicalStreamWriter
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


Joe Walnes, http://xstream.codehaus.org/