com.google.gdata.wireformats

Interface XmlGenerator.ElementGenerator

All Known Implementing Classes:

XmlGenerator.XmlElementGenerator

Enclosing class:

XmlGenerator

public static interface XmlGenerator.ElementGenerator

The ElementGenerator interface is implemented by helper classes that will generate the start element, text content, and end element syntax for an Element to an XmlWriter.

The generic implementation of this interface is provided by the XmlGenerator.XmlElementGenerator class, but it may be overridden by element types that want to take more direct control over XML output for a given element.

Method Summary

Methods

Modifier and Type	Method and Description
void	endElement(XmlWriter xw, Element e, ElementMetadata<?,?> metadata) End an element, writing a close tag if needed.
boolean	startElement(XmlWriter xw, Element parent, Element e, ElementMetadata<?,?> metadata) Start an element.
void	textContent(XmlWriter xw, Element e, ElementMetadata<?,?> metadata) Write the text content for an element.

Method Detail

startElement

boolean startElement(XmlWriter xw,
                   Element parent,
                   Element e,
                   ElementMetadata<?,?> metadata)
                     throws IOException

Start an element. If an ElementGenerator instances writes a full element tag, it should return false to indicate that textContent and child elements should not be added.

Parameters:

xw - the xml writer to write to.

parent - the parent element.

e - the element to start.

metadata - the metadata for the element

Returns:

true if child elements should be written, false if the element was fully written.

Throws:

IOException - if an error occurs while writing to the writer.

textContent

void textContent(XmlWriter xw,
               Element e,
               ElementMetadata<?,?> metadata)
                 throws IOException

Write the text content for an element.

Throws:

IOException

endElement

void endElement(XmlWriter xw,
              Element e,
              ElementMetadata<?,?> metadata)
                throws IOException

End an element, writing a close tag if needed.

Throws:

IOException