name.pehl.piriti.xml.client

Interface XmlWriter<T>

Type Parameters:

T - The type

All Superinterfaces:

com.google.gwt.event.shared.HasHandlers, HasModelWriteHandler<T>

All Known Implementing Classes:

AbstractXmlWriter

public interface XmlWriter<T>
extends HasModelWriteHandler<T>

Interface for serializing an instance of T or a list of Ts to XML. All properties of T and superclasses of T are handled by the generated XmlWriter implementation. Null values in T result in empty elements in the resulting XML.

The setup of the XmlWriter is inspired by the UiBinder and is typically specified as an inner class:

 pubilc RunnableMessageContext
 {
     interface Writer extends XmlWriter<RunnableMessageContext> {}
     public static final Writer JSON_WRITER = GWT.create(Writer.class);
     
     // The properties of this POJO
 }
 

XML can then be generated by calling

 RunnableMessageContext rmc = new RunnableMessageContext();
 ...
 String xml = RunnableMessageContext.XML_WRITER.toXml(rmc);
 

Version:

$LastChangedRevision: 46 $

Author:

$LastChangedBy: harald.pehl $

Method Summary

Methods

Modifier and Type	Method and Description
String	toXml(List<T> models) Serializes the specified models to XML.
String	toXml(List<T> models, String rootElement) Serializes the specified models to XML using the specified name for the root element.
String	toXml(List<T> models, String rootElement, String nestedRootElement) Serializes the specified models to XML using the specified names for the root and nested elements.
String	toXml(T model) Serializes the specified model to XML.
String	toXml(T model, String rootElement) Serializes the specified model to XML using the specified name for the root element.

Methods inherited from interface name.pehl.piriti.commons.client.HasModelWriteHandler

addModelWriteHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Method Detail

toXml

String toXml(List<T> models)

Serializes the specified models to XML. For the root element and the nested elements the following default values are used:

1. Root element: The classname of T with the first letter converted to lowercase and a trailing 's'
2. Nested elements: The classname of T with the first letter converted to lowercase

Given you want to serialize a list of books:

 List<Book> books = ...;
 XmlWriter<Book> xmlWriter = ...;
 String xml = xmlWriter.toXml(books);
 

Then the xml will have the following structure:

 <books>
     <book>
         ...
     </book>
     ...
 </books>
 

Parameters:

models - the models to serialize

Returns:

the relevant XML or null if models is null

toXml

String toXml(List<T> models,
           String rootElement)

Serializes the specified models to XML using the specified name for the root element. For the nested elements the classname of T with the first letter converted to lowercase is used.

Parameters:

models - the models to serialize

rootElement - the name for the root element

Returns:

the relevant XML or null if models and/or rootElement is null

toXml

String toXml(List<T> models,
           String rootElement,
           String nestedRootElement)

Serializes the specified models to XML using the specified names for the root and nested elements.

Parameters:

models - the models to serialize

rootElement - the name for the root element

nestedRootElement - the name of the nested elements

Returns:

the relevant XML or null if models, rootElement and/or nestedRootElement is null

toXml

String toXml(T model)

Serializes the specified model to XML. For the root element the classname of T with the first letter converted to lowercase is used.

Given you want to serialize a book:

 Book book = ...;
 XmlWriter<Book> xmlWriter = ...;
 String xml = xmlWriter.toXml(book);
 

Then the xml will have the following structure:

 <book>
     ...
 </book>
 

Parameters:

model - the model to serialize

Returns:

the relevant XML or null if model is null

toXml

String toXml(T model,
           String rootElement)

Serializes the specified model to XML using the specified name for the root element.

Parameters:

model - the model to serialize

rootElement - the name for the root element

Returns:

the relevant XML or null if model and/or rootElement is null