com.gluonhq.connect.converter

Class XmlInputConverter<T>

java.lang.Object

com.gluonhq.connect.converter.InputStreamInputConverter<T>

com.gluonhq.connect.converter.XmlInputConverter<T>

Type Parameters:

T - the type of the object to convert the XML Object into

All Implemented Interfaces:

InputConverter<T>

public class XmlInputConverter<T>
extends InputStreamInputConverter<T>

An InputConverter that converts a XML Object read from an InputStream into an object.

Constructor Summary

Constructors

Constructor and Description
XmlInputConverter(java.lang.Class<T> targetClass) Construct a new instance of a XmlInputConverter that is able to convert the data read from the InputStream into objects of the specified targetClass.
XmlInputConverter(java.lang.Class<T> targetClass, java.lang.String tag) Construct a new instance of a XmlInputConverter that is able to convert the data read from the InputStream into objects of the specified targetClass.

Method Summary

Modifier and Type	Method and Description
T	read() Reads an object from a certain input source and returns it.

Methods inherited from class com.gluonhq.connect.converter.InputStreamInputConverter

getInputStream, setInputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlInputConverter

public XmlInputConverter(java.lang.Class<T> targetClass)

Construct a new instance of a XmlInputConverter that is able to convert the data read from the InputStream into objects of the specified targetClass.

Parameters:

targetClass - The class defining the objects being converted from XML.

XmlInputConverter

public XmlInputConverter(java.lang.Class<T> targetClass,
                         java.lang.String tag)

Construct a new instance of a XmlInputConverter that is able to convert the data read from the InputStream into objects of the specified targetClass. Often, the XML returned by web services has the relevant information nested or wrapped in rootnodes. If there is a 1-1 mapping between the data and the Object, we would end up with unused wrapper classes. By specifying the name of the node that contains the relevant information, the wrapping data is ignored.

Parameters:

targetClass - The class defining the objects being converted from XML.

tag - the nodename of the rootnode containing the relevant information.

Method Detail

read

public T read()

Description copied from interface: InputConverter

Reads an object from a certain input source and returns it.

Returns:

An object read from a certain input source.