com.github.agadar.nationstates.xmlconverter

Interface IXmlConverter

All Known Implementing Classes:

XmlConverter

public interface IXmlConverter

Converts XML streams to properly annotated objects, and vice versa.

Author:

Agadar (https://github.com/Agadar/)

Method Summary

Modifier and Type	Method and Description
ByteArrayOutputStream	objectToXml(Object obj) Uses JAXB to parse an object to an output stream.
void	registerTypes(Class... types) Adds the given classes to the JAXB context so that they can be parsed to from retrieved XML responses and files.
<T> T	xmlToObject(InputStream xml, Class<T> toType) Uses JAXB to parse the supplied XML stream to an instance of the specified type.

Method Detail

registerTypes

void registerTypes(Class... types)

Adds the given classes to the JAXB context so that they can be parsed to from retrieved XML responses and files. Classes that inherit any of the classes in the domain-package don't need any xml-annotations. Classes that do no inherit those classes, do need xml-annotations.

Parameters:

types - the classes to add to the JAXB context

xmlToObject

<T> T xmlToObject(InputStream xml,
                  Class<T> toType)

Uses JAXB to parse the supplied XML stream to an instance of the specified type.

Type Parameters:

T - the type to parse to

Parameters:

xml - the XML stream

toType - the type to parse to

Returns:

instance of the specified type

objectToXml

ByteArrayOutputStream objectToXml(Object obj)

Uses JAXB to parse an object to an output stream.

Parameters:

obj - object to parse to output stream

Returns:

an output stream