org.apache.axiom.om.impl.llom

Class PushOMBuilder

java.lang.Object

org.apache.axiom.util.stax.AbstractXMLStreamWriter

org.apache.axiom.om.impl.llom.PushOMBuilder

All Implemented Interfaces:

XMLStreamWriter, DataHandlerWriter

public class PushOMBuilder
extends AbstractXMLStreamWriter
implements DataHandlerWriter

Field Summary

Fields inherited from interface org.apache.axiom.ext.stax.datahandler.DataHandlerWriter

PROPERTY

Constructor Summary

Constructors

Constructor and Description
PushOMBuilder(OMSourcedElementImpl root)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doWriteAttribute(String localName, String value)
protected void	doWriteAttribute(String prefix, String namespaceURI, String localName, String value)
protected void	doWriteCData(String data)
protected void	doWriteCharacters(char[] text, int start, int len)
protected void	doWriteCharacters(String text)
protected void	doWriteComment(String data)
protected void	doWriteDefaultNamespace(String namespaceURI)
protected void	doWriteDTD(String dtd)
protected void	doWriteEmptyElement(String localName)
protected void	doWriteEmptyElement(String prefix, String localName, String namespaceURI)
protected void	doWriteEndDocument()
protected void	doWriteEndElement()
protected void	doWriteEntityRef(String name)
protected void	doWriteNamespace(String prefix, String namespaceURI)
protected void	doWriteProcessingInstruction(String target)
protected void	doWriteProcessingInstruction(String target, String data)
protected void	doWriteStartDocument()
protected void	doWriteStartDocument(String version)
protected void	doWriteStartDocument(String encoding, String version)
protected void	doWriteStartElement(String localName)
protected void	doWriteStartElement(String prefix, String localName, String namespaceURI)
void	flush()
Object	getProperty(String name)
void	writeDataHandler(DataHandlerProvider dataHandlerProvider, String contentID, boolean optimize) Write binary content to the stream.
void	writeDataHandler(DataHandler dataHandler, String contentID, boolean optimize) Write binary content to the stream.

Methods inherited from class org.apache.axiom.util.stax.AbstractXMLStreamWriter

getNamespaceContext, getPrefix, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEndElement, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement, writeStartElement

Methods inherited from class java.lang.Object

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

Constructor Detail

PushOMBuilder

public PushOMBuilder(OMSourcedElementImpl root)
              throws XMLStreamException

Throws:

XMLStreamException

Method Detail

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamWriter

Throws:

IllegalArgumentException

doWriteStartDocument

protected void doWriteStartDocument()

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

doWriteStartDocument

protected void doWriteStartDocument(String encoding,
                                    String version)

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

doWriteStartDocument

protected void doWriteStartDocument(String version)

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

doWriteEndDocument

protected void doWriteEndDocument()

Specified by:

doWriteEndDocument in class AbstractXMLStreamWriter

doWriteDTD

protected void doWriteDTD(String dtd)
                   throws XMLStreamException

Specified by:

doWriteDTD in class AbstractXMLStreamWriter

Throws:

XMLStreamException

doWriteStartElement

protected void doWriteStartElement(String prefix,
                                   String localName,
                                   String namespaceURI)

Specified by:

doWriteStartElement in class AbstractXMLStreamWriter

doWriteStartElement

protected void doWriteStartElement(String localName)
                            throws XMLStreamException

Specified by:

doWriteStartElement in class AbstractXMLStreamWriter

Throws:

XMLStreamException

doWriteEndElement

protected void doWriteEndElement()

Specified by:

doWriteEndElement in class AbstractXMLStreamWriter

doWriteEmptyElement

protected void doWriteEmptyElement(String prefix,
                                   String localName,
                                   String namespaceURI)

Specified by:

doWriteEmptyElement in class AbstractXMLStreamWriter

doWriteEmptyElement

protected void doWriteEmptyElement(String localName)
                            throws XMLStreamException

Specified by:

doWriteEmptyElement in class AbstractXMLStreamWriter

Throws:

XMLStreamException

doWriteAttribute

protected void doWriteAttribute(String prefix,
                                String namespaceURI,
                                String localName,
                                String value)

Specified by:

doWriteAttribute in class AbstractXMLStreamWriter

doWriteAttribute

protected void doWriteAttribute(String localName,
                                String value)
                         throws XMLStreamException

Specified by:

doWriteAttribute in class AbstractXMLStreamWriter

Throws:

XMLStreamException

doWriteNamespace

protected void doWriteNamespace(String prefix,
                                String namespaceURI)

Specified by:

doWriteNamespace in class AbstractXMLStreamWriter

doWriteDefaultNamespace

protected void doWriteDefaultNamespace(String namespaceURI)

Specified by:

doWriteDefaultNamespace in class AbstractXMLStreamWriter

doWriteCharacters

protected void doWriteCharacters(char[] text,
                                 int start,
                                 int len)

Specified by:

doWriteCharacters in class AbstractXMLStreamWriter

doWriteCharacters

protected void doWriteCharacters(String text)

Specified by:

doWriteCharacters in class AbstractXMLStreamWriter

doWriteCData

protected void doWriteCData(String data)

Specified by:

doWriteCData in class AbstractXMLStreamWriter

doWriteComment

protected void doWriteComment(String data)

Specified by:

doWriteComment in class AbstractXMLStreamWriter

doWriteEntityRef

protected void doWriteEntityRef(String name)
                         throws XMLStreamException

Specified by:

doWriteEntityRef in class AbstractXMLStreamWriter

Throws:

XMLStreamException

doWriteProcessingInstruction

protected void doWriteProcessingInstruction(String target,
                                            String data)

Specified by:

doWriteProcessingInstruction in class AbstractXMLStreamWriter

doWriteProcessingInstruction

protected void doWriteProcessingInstruction(String target)

Specified by:

doWriteProcessingInstruction in class AbstractXMLStreamWriter

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

writeDataHandler

public void writeDataHandler(DataHandler dataHandler,
                             String contentID,
                             boolean optimize)
                      throws IOException,
                             XMLStreamException

Description copied from interface: DataHandlerWriter

Write binary content to the stream. The implementation may choose to write the data as base64 encoded character data or using an optimization protocol such as XOP/MTOM.

Specified by:

writeDataHandler in interface DataHandlerWriter

Parameters:

dataHandler - the binary content to write

contentID - an existing content ID for the binary data (see above)

optimize - indicates whether the content is eligible for optimization (see above)

Throws:

IOException - if an error occurs while reading from the data handler

XMLStreamException - if an error occurs while writing to the underlying stream

writeDataHandler

public void writeDataHandler(DataHandlerProvider dataHandlerProvider,
                             String contentID,
                             boolean optimize)
                      throws IOException,
                             XMLStreamException

Description copied from interface: DataHandlerWriter

Write binary content to the stream. This method allows the implementation to defer loading of the content. More precisely, if the implementation decides to use an optimization scheme such as XOP, then the content will not be written immediately to the underlying stream, but only after the XML infoset is complete. If the caller uses this method, the implementation can defer the actual loading of the binary content.

Specified by:

writeDataHandler in interface DataHandlerWriter

Parameters:

dataHandlerProvider - the binary content to write

contentID - an existing content ID for the binary data (see above)

optimize - indicates whether the content is eligible for optimization (see above)

Throws:

IOException - If an error occurs while reading from the data handler. Since the implementation is free to override the supplied optimize argument, it may attempt to load the binary data immediately. Because this operation may fail, the method must declare this exception.

XMLStreamException - if an error occurs while writing to the underlying stream