com.boomi.connector.util.xml

Class ElementWrapperEventGenerator

java.lang.Object

com.boomi.connector.util.xml.ElementWrapperEventGenerator

public class ElementWrapperEventGenerator
extends Object

Utility for generating wrapper element events. Generates star-element and end-element events for one or more wrapper elements. Note, once addStartEvents(javax.xml.stream.XMLEventWriter) or addEndEvents(javax.xml.stream.XMLEventWriter) has been invoked, none of the other builder methods should be invoked again (i.e. the generator may only be configured once). However, addStartEvents and addEndEvents may be (re)used as many times as necessary.

In order to generate XML which looks like:

 <rootEl>
   <listEl size="4">
     // other element data added here
   </listEl>
 <rootEl>
 

You would configure a generator like:

 ElementWrapperEventGenerator generator = new ElementWrapperEventGenerator(factory).addWrapperElement("rootEl")
         .addWrapperElement("listEl").addAttribute("size", "4");

 // add the initial wrapper events
 generator.addStartEvents(writer);

 // ... add other element data here

 // add closing wrapper events
 generator.addEndEvents(writer);
 

Constructor Summary

Constructors

Constructor and Description
ElementWrapperEventGenerator(XMLEventFactory factory)

Method Summary

Modifier and Type	Method and Description
ElementWrapperEventGenerator	addAttribute(QName qName, String value) Adds a an attribute with the given QName and value to the most recently added wrapper element.
ElementWrapperEventGenerator	addAttribute(String name, String value) Adds a an attribute with the given name and value to the most recently added wrapper element.
ElementWrapperEventGenerator	addAttribute(String prefix, String namespace, String name, String value) Adds a an attribute with the given name/prefix/namespace and value to the most recently added wrapper element.
void	addEndEvents(XMLEventWriter writer) Adds all end-events for the currently configured wrapper elements and attributes to the given writer.
void	addStartEvents(XMLEventWriter writer) Adds all start-events for the currently configured wrapper elements and attributes to the given writer.
ElementWrapperEventGenerator	addWrapperElement(QName qName) Adds a new wrapper element with the given QName.
ElementWrapperEventGenerator	addWrapperElement(String name) Adds a new wrapper element with the given name.
ElementWrapperEventGenerator	addWrapperElement(String prefix, String namespace, String name) Adds a new wrapper element with the given name/prefix/namespace.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementWrapperEventGenerator

public ElementWrapperEventGenerator(XMLEventFactory factory)

Method Detail

addWrapperElement

public ElementWrapperEventGenerator addWrapperElement(String name)

Adds a new wrapper element with the given name. Subsequent calls to addAttribute(java.lang.String, java.lang.String) will affect this new element.

addWrapperElement

public ElementWrapperEventGenerator addWrapperElement(String prefix,
                                                      String namespace,
                                                      String name)

Adds a new wrapper element with the given name/prefix/namespace. Subsequent calls to addAttribute(java.lang.String, java.lang.String) will affect this new element.

addWrapperElement

public ElementWrapperEventGenerator addWrapperElement(QName qName)

Adds a new wrapper element with the given QName. Subsequent calls to addAttribute(java.lang.String, java.lang.String) will affect this new element.

addAttribute

public ElementWrapperEventGenerator addAttribute(String name,
                                                 String value)

Adds a an attribute with the given name and value to the most recently added wrapper element.

addAttribute

public ElementWrapperEventGenerator addAttribute(String prefix,
                                                 String namespace,
                                                 String name,
                                                 String value)

Adds a an attribute with the given name/prefix/namespace and value to the most recently added wrapper element.

addAttribute

public ElementWrapperEventGenerator addAttribute(QName qName,
                                                 String value)

Adds a an attribute with the given QName and value to the most recently added wrapper element.

addStartEvents

public void addStartEvents(XMLEventWriter writer)
                    throws XMLStreamException

Adds all start-events for the currently configured wrapper elements and attributes to the given writer.

Note, none of the addWrapperElement(java.lang.String) or addAttribute(java.lang.String, java.lang.String) methods may be used again once this method has been called the first time. This method may be invoked as many times as desired.

Parameters:

writer - the writer to which to add the start-events

Throws:

XMLStreamException

addEndEvents

public void addEndEvents(XMLEventWriter writer)
                  throws XMLStreamException

Adds all end-events for the currently configured wrapper elements and attributes to the given writer.

Note, none of the addWrapperElement(java.lang.String) or addAttribute(java.lang.String, java.lang.String) methods may be used again once this method has been called the first time. This method may be invoked as many times as desired.

Parameters:

writer - the writer to which to add the end-events

Throws:

XMLStreamException