com.github.agadar.nationstates.xmlconverter

Class XmlConverter

java.lang.Object

com.github.agadar.nationstates.xmlconverter.XmlConverter

All Implemented Interfaces:

IXmlConverter

public final class XmlConverter
extends Object
implements IXmlConverter

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

Author:

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

Constructor Summary

Constructors

Constructor and Description
XmlConverter()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlConverter

public XmlConverter()

Method Detail

registerTypes

public final 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.

Specified by:

registerTypes in interface IXmlConverter

Parameters:

types - the classes to add to the JAXB context

xmlToObject

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

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

Specified by:

xmlToObject in interface IXmlConverter

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

public final ByteArrayOutputStream objectToXml(Object obj)

Uses JAXB to parse an object to an output stream.

Specified by:

objectToXml in interface IXmlConverter

Parameters:

obj - object to parse to output stream

Returns:

an output stream