Package net.officefloor.plugin.xml.marshall.tree

Class CollectionXmlMapping

java.lang.Object

net.officefloor.plugin.xml.marshall.tree.AbstractXmlMapping

net.officefloor.plugin.xml.marshall.tree.AbstractTypeXmlMapping

net.officefloor.plugin.xml.marshall.tree.CollectionXmlMapping

All Implemented Interfaces:

XmlMapping, XmlWriter

public class CollectionXmlMapping
extends AbstractTypeXmlMapping

Implementation of XmlMapping to iterate over a Collection object in context.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class net.officefloor.plugin.xml.marshall.tree.AbstractTypeXmlMapping

contexts, elementEnd, elementName, elementStart, items

Fields inherited from class net.officefloor.plugin.xml.marshall.tree.AbstractXmlMapping

getMethod

Constructor Summary

Constructors

Constructor	Description
CollectionXmlMapping(java.lang.String elementName, java.lang.reflect.Method getMethod, XmlMappingMetaData[] items, TranslatorRegistry translatorRegistry, ReferencedXmlMappingRegistry referenceRegistry)	Initiate with details to marshall the Collection.

Method Summary

Modifier and Type	Method	Description
protected void	writeSpecificXml(java.lang.Object object, XmlOutput output)	Writes the specific XML for the input object.

Methods inherited from class net.officefloor.plugin.xml.marshall.tree.AbstractTypeXmlMapping

getMatchingContext, writeXml

Methods inherited from class net.officefloor.plugin.xml.marshall.tree.AbstractXmlMapping

getWriter, map

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionXmlMapping

public CollectionXmlMapping(java.lang.String elementName,
                            java.lang.reflect.Method getMethod,
                            XmlMappingMetaData[] items,
                            TranslatorRegistry translatorRegistry,
                            ReferencedXmlMappingRegistry referenceRegistry)
                     throws XmlMarshallException

Initiate with details to marshall the Collection.

Parameters:

elementName - Name of XML element for this mapping or null if no element.

getMethod - Method to obtain the collection.

items - Configuration for items within the Collection.

referenceRegistry - Registry of XmlMapping that may be referenced.

translatorRegistry - Registry of the Translator instances.

Throws:

XmlMarshallException - If fails to configure.

Method Detail

writeSpecificXml

protected void writeSpecificXml(java.lang.Object object,
                                XmlOutput output)
                         throws XmlMarshallException

Description copied from class: AbstractTypeXmlMapping

Writes the specific XML for the input object.

Specified by:

writeSpecificXml in class AbstractTypeXmlMapping

Parameters:

object - Object to be written as XML.

output - Output to write the XML.

Throws:

XmlMarshallException - If fails to write the XML.