com.sencha.gxt.data.client.writer

Class XmlWriter<M>

java.lang.Object

com.sencha.gxt.data.shared.writer.AutoBeanWriter<M,String>

com.sencha.gxt.data.client.writer.XmlWriter<M>

Type Parameters:

M - the starting data format for the model to be inputed

All Implemented Interfaces:

DataWriter<M,String>

public class XmlWriter<M>
extends AutoBeanWriter<M,String>

A AutoBeanWriter that outputs XML. The AutoBean.PropertyName annotation is read as the path to the node to write out the values in essentially the same way that XmlReader works, though conditionals are not allowed. XML does not have a concept of null, so instead this writer omits any null values. In most cases this will yield the same contents on reading the values back out again, as the lack of a value can be understood to mean null, but one exception is using a null in a collection. A List with a null entry will have that entry completely skipped by this writer.

Constructor Summary

Constructors

Constructor and Description
XmlWriter(AutoBeanFactory factory, Class<M> clazz, String rootTag) Creates a new XML writer that can format an object into XML.

Method Summary

Methods

Modifier and Type	Method and Description
String	write(M model) Converts a source model to its equivalent target type.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriter

public XmlWriter(AutoBeanFactory factory,
         Class<M> clazz,
         String rootTag)

Creates a new XML writer that can format an object into XML.

Parameters:

factory - an auto bean factory that can decode objects of type M

clazz - the class to write

rootTag - the root tag of the XML document

Method Detail

write

public String write(M model)

Description copied from interface: DataWriter

Converts a source model to its equivalent target type.

Parameters:

model - the source model

Returns:

the equivalent target type