com.atlassian.confluence.setup.xstream

Interface ConfluenceXStream

All Known Subinterfaces:

ConfluenceXStreamInternal

All Known Implementing Classes:

ConfluenceXStreamImpl

public interface ConfluenceXStream

XStream wrapper to provide Object's XML based serialization and deserialization. Avoid using XStream directly to take advantages of Confluence's XStream storage backward-compatibility.

Since:

7.10.0

Method Summary

Modifier and Type	Method and Description
Object	fromXML(Reader reader) Deserialize an object from an XML Reader.
Object	fromXML(String xml) Deserialize an object from an XML String.
String	toXML(Object obj) Serialize an object to a pretty-printed XML String.
void	toXML(Object obj, Writer writer) Serialize an object to the given Writer as pretty-printed XML.

Method Detail

toXML

String toXML(Object obj)

Serialize an object to a pretty-printed XML String.

Throws:

com.thoughtworks.xstream.XStreamException - if the object cannot be serialized

toXML

void toXML(Object obj,
           Writer writer)

Serialize an object to the given Writer as pretty-printed XML. The Writer will be flushed afterwards and in case of an exception.

Throws:

com.thoughtworks.xstream.XStreamException - if the object cannot be serialized

fromXML

Object fromXML(String xml)

Deserialize an object from an XML String.

Throws:

com.thoughtworks.xstream.XStreamException - if the object cannot be deserialized

fromXML

Object fromXML(Reader reader)

Deserialize an object from an XML Reader.

Throws:

com.thoughtworks.xstream.XStreamException - if the object cannot be deserialized