public class

XStreamer

extends Object
java.lang.Object
   ↳ com.thoughtworks.xstream.XStreamer

Class Overview

Self-contained XStream generator. The class is a utility to write XML streams that contain additionally the XStream that was used to serialize the object graph. Such a stream can be unmarshalled using this embedded XStream instance, that kept any settings.

Summary

Public Constructors
XStreamer()
Public Methods
Object fromXML(HierarchicalStreamDriver driver, Reader xml)
Deserialize a self-contained XStream with object from an XML Reader.
Object fromXML(Reader xml)
Deserialize a self-contained XStream with object from an XML Reader.
Object fromXML(HierarchicalStreamDriver driver, String xml)
Deserialize a self-contained XStream with object from a String.
Object fromXML(String xml)
Deserialize a self-contained XStream with object from a String.
String toXML(XStream xstream, Object obj)
Serialize an object including the XStream to a pretty-printed XML String.
void toXML(XStream xstream, Object obj, Writer out)
Serialize an object including the XStream to the given Writer as pretty-printed XML.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public XStreamer ()

Public Methods

public Object fromXML (HierarchicalStreamDriver driver, Reader xml)

Deserialize a self-contained XStream with object from an XML Reader.

Throws
IOException if an error occurs reading from the Reader.
ClassNotFoundException if a class in the XML stream cannot be found
XStreamException if the object cannot be deserialized

public Object fromXML (Reader xml)

Deserialize a self-contained XStream with object from an XML Reader. The method will use internally an XppDriver to load the contained XStream instance.

Throws
IOException if an error occurs reading from the Reader.
ClassNotFoundException if a class in the XML stream cannot be found
XStreamException if the object cannot be deserialized

public Object fromXML (HierarchicalStreamDriver driver, String xml)

Deserialize a self-contained XStream with object from a String.

Throws
ClassNotFoundException if a class in the XML stream cannot be found
ObjectStreamException if the XML contains non-deserializable elements
XStreamException if the object cannot be deserialized

public Object fromXML (String xml)

Deserialize a self-contained XStream with object from a String. The method will use internally an XppDriver to load the contained XStream instance.

Throws
ClassNotFoundException if a class in the XML stream cannot be found
ObjectStreamException if the XML contains non-deserializable elements
XStreamException if the object cannot be deserialized

public String toXML (XStream xstream, Object obj)

Serialize an object including the XStream to a pretty-printed XML String.

Throws
ObjectStreamException if the XML contains non-serializable elements
XStreamException if the object cannot be serialized

public void toXML (XStream xstream, Object obj, Writer out)

Serialize an object including the XStream to the given Writer as pretty-printed XML.

Warning: XStream will serialize itself into this XML stream. To read such an XML code, you should use fromXML(Reader) or one of the other overloaded methods. Since a lot of internals are written into the stream, you cannot expect to use such an XML to work with another XStream version or with XStream running on different JDKs and/or versions. We have currently no JDK 1.3 support, nor will the PureReflectionConverter work with a JDK less than 1.5.

Throws
IOException if an error occurs reading from the Writer.
XStreamException if the object cannot be serialized