io.datafx.io.converter

Class XmlConverter<T>

java.lang.Object

io.datafx.io.converter.InputStreamConverter<T>

io.datafx.io.converter.XmlConverter<T>

Type Parameters:

T - The type of the converted objects.

All Implemented Interfaces:

Converter<java.io.InputStream,T>

public class XmlConverter<T>
extends InputStreamConverter<T>

A Converter implementation that converts a InputStream into one or more instances of a java class with type T.

Constructor Summary

Constructors

Constructor and Description
XmlConverter(java.lang.Class<T> clazz) Create an XmlConverter that will generate instances of the specified class.
XmlConverter(java.lang.String tag, java.lang.Class<T> clazz) Create an XmlConverter that will generate instances of the specified class.

Method Summary

Modifier and Type	Method and Description
T	get() Get the next available data entity in the desired type
void	initialize(java.io.InputStream is) Initialize the raw data.
boolean	next() Indicate whether or not more data can be expected from this converter.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlConverter

public XmlConverter(java.lang.Class<T> clazz)

Create an XmlConverter that will generate instances of the specified class.

Parameters:

clazz - the entities returned by the get() call will be of class clazz

XmlConverter

public XmlConverter(java.lang.String tag,
                    java.lang.Class<T> clazz)

Create an XmlConverter that will generate instances of the specified class. Using this constructor, it is assumed that the entities are contained within a XML structure in a DOM with the name specified by the value of the tag parameter.

Parameters:

clazz - the entities returned by the get() call will be of class clazz

tag - the name of the xml element(s) holding the data entity(ies).

Method Detail

get

public T get()

Description copied from interface: Converter

Get the next available data entity in the desired type

Returns:

the next available data

next

public boolean next()

Description copied from interface: Converter

Indicate whether or not more data can be expected from this converter. It is up to the implementation to detect if we can deliver more data entities or not. If this method returns false a call to Converter.get() will fail.

Returns:

true if more data can be obtained from this converter, false otherwise

initialize

public void initialize(java.io.InputStream is)

Description copied from interface: Converter

Initialize the raw data. In many cases, some initialization is required on the raw data before the conversion to one or more objects can be performed. In the case of an XmlConverter, for example, the DOM-model is created in this method.

Parameters:

is - the raw input.