org.mini2Dx.core.serialization

Interface XmlSerializer

All Known Implementing Classes:

AndroidXmlSerializer, DesktopXmlSerializer, IOSXmlSerializer

public interface XmlSerializer

Common interface to XML serialization implementations. All implementations serialize data based on Field annotations

Method Summary

Modifier and Type	Method and Description
<T> T	fromXml(java.io.Reader xmlReader, java.lang.Class<T> clazz) Reads an XML document from a Reader and converts it into an object of the specified type
<T> T	fromXml(java.lang.String xml, java.lang.Class<T> clazz) Reads a XML document and converts it into an object of the specified type
<T> java.lang.String	toXml(T object) Writes a XML document by searching the object for Field annotations
<T> void	toXml(T object, java.io.Writer writer) Writes a XML document to a Writer by searching the object for Field annotations

Method Detail

fromXml

<T> T fromXml(java.lang.String xml,
              java.lang.Class<T> clazz)
       throws SerializationException

Reads a XML document and converts it into an object of the specified type

Parameters:

xml - The XML document

clazz - The Class to convert the document to

Returns:

The object deserialized from XML

Throws:

SerializationException - Thrown when the data is invalid

fromXml

<T> T fromXml(java.io.Reader xmlReader,
              java.lang.Class<T> clazz)
       throws SerializationException

Reads an XML document from a Reader and converts it into an object of the specified type

Parameters:

xmlReader - The input stream reading the XML document

clazz - The Class to convert the document to

Returns:

The object deserialized from XML

Throws:

SerializationException - Thrown when the data is invalid

toXml

<T> java.lang.String toXml(T object)
                    throws SerializationException

Writes a XML document by searching the object for Field annotations

Parameters:

object - The object to convert to XML

Returns:

The object serialized as XML

Throws:

SerializationException - Thrown when the object is invalid

toXml

<T> void toXml(T object,
               java.io.Writer writer)
        throws SerializationException

Writes a XML document to a Writer by searching the object for Field annotations

Parameters:

object - The object to convert to XML

writer - The stream to write the XML document to

Throws:

SerializationException - Thrown when the object is invalid