org.apache.axiom.util.stax

Class AbstractXMLStreamWriter

java.lang.Object

org.apache.axiom.util.stax.AbstractXMLStreamWriter

All Implemented Interfaces:

javax.xml.stream.XMLStreamWriter

Direct Known Subclasses:

NamespaceContextCorrectingXMLStreamWriterWrapper, PushOMBuilder

public abstract class AbstractXMLStreamWriter
extends java.lang.Object
implements javax.xml.stream.XMLStreamWriter

Partial implementation of the XMLStreamWriter interface. It handles namespace bindings, i.e. the methods related to the namespace context. Subclasses only need to implement write methods that take a prefix together with the namespace URI argument. This class implements all XMLStreamWriter methods that have a namespace URI argument, but no prefix argument.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inEmptyElement
private static org.apache.commons.logging.Log	log
private ScopedNamespaceContext	namespaceContext

Constructor Summary

Constructors

Constructor and Description
AbstractXMLStreamWriter()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doWriteAttribute(java.lang.String localName, java.lang.String value)
protected abstract void	doWriteAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
protected abstract void	doWriteCData(java.lang.String data)
protected abstract void	doWriteCharacters(char[] text, int start, int len)
protected abstract void	doWriteCharacters(java.lang.String text)
protected abstract void	doWriteComment(java.lang.String data)
protected abstract void	doWriteDefaultNamespace(java.lang.String namespaceURI)
protected abstract void	doWriteDTD(java.lang.String dtd)
protected abstract void	doWriteEmptyElement(java.lang.String localName)
protected abstract void	doWriteEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
protected abstract void	doWriteEndDocument()
protected abstract void	doWriteEndElement()
protected abstract void	doWriteEntityRef(java.lang.String name)
protected abstract void	doWriteNamespace(java.lang.String prefix, java.lang.String namespaceURI)
protected abstract void	doWriteProcessingInstruction(java.lang.String target)
protected abstract void	doWriteProcessingInstruction(java.lang.String target, java.lang.String data)
protected abstract void	doWriteStartDocument()
protected abstract void	doWriteStartDocument(java.lang.String version)
protected abstract void	doWriteStartDocument(java.lang.String encoding, java.lang.String version)
protected abstract void	doWriteStartElement(java.lang.String localName)
protected abstract void	doWriteStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
javax.xml.namespace.NamespaceContext	getNamespaceContext()
java.lang.String	getPrefix(java.lang.String uri)
private java.lang.String	internalGetPrefix(java.lang.String namespaceURI)
private void	internalSetPrefix(java.lang.String prefix, java.lang.String uri)
void	setDefaultNamespace(java.lang.String uri)
void	setNamespaceContext(javax.xml.namespace.NamespaceContext context)
void	setPrefix(java.lang.String prefix, java.lang.String uri)
void	writeAttribute(java.lang.String localName, java.lang.String value)
void	writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void	writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void	writeCData(java.lang.String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(java.lang.String text)
void	writeComment(java.lang.String data)
void	writeDefaultNamespace(java.lang.String namespaceURI)
void	writeDTD(java.lang.String dtd)
void	writeEmptyElement(java.lang.String localName)
void	writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(java.lang.String name)
void	writeNamespace(java.lang.String prefix, java.lang.String namespaceURI)
void	writeProcessingInstruction(java.lang.String target)
void	writeProcessingInstruction(java.lang.String target, java.lang.String data)
void	writeStartDocument()
void	writeStartDocument(java.lang.String version)
void	writeStartDocument(java.lang.String encoding, java.lang.String version)
void	writeStartElement(java.lang.String localName)
void	writeStartElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.stream.XMLStreamWriter

close, flush, getProperty

Field Detail

log

private static final org.apache.commons.logging.Log log

namespaceContext

private final ScopedNamespaceContext namespaceContext

inEmptyElement

private boolean inEmptyElement

Constructor Detail

AbstractXMLStreamWriter

public AbstractXMLStreamWriter()

Method Detail

getNamespaceContext

public final javax.xml.namespace.NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamWriter

setNamespaceContext

public final void setNamespaceContext(javax.xml.namespace.NamespaceContext context)
                               throws javax.xml.stream.XMLStreamException

Specified by:

setNamespaceContext in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

getPrefix

public final java.lang.String getPrefix(java.lang.String uri)
                                 throws javax.xml.stream.XMLStreamException

Specified by:

getPrefix in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

internalSetPrefix

private void internalSetPrefix(java.lang.String prefix,
                               java.lang.String uri)

setDefaultNamespace

public final void setDefaultNamespace(java.lang.String uri)
                               throws javax.xml.stream.XMLStreamException

Specified by:

setDefaultNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

setPrefix

public final void setPrefix(java.lang.String prefix,
                            java.lang.String uri)
                     throws javax.xml.stream.XMLStreamException

Specified by:

setPrefix in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public final void writeStartDocument()
                              throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

protected abstract void doWriteStartDocument()
                                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public final void writeStartDocument(java.lang.String encoding,
                                     java.lang.String version)
                              throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

protected abstract void doWriteStartDocument(java.lang.String encoding,
                                             java.lang.String version)
                                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public final void writeStartDocument(java.lang.String version)
                              throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

protected abstract void doWriteStartDocument(java.lang.String version)
                                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeDTD

public final void writeDTD(java.lang.String dtd)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeDTD in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteDTD

protected abstract void doWriteDTD(java.lang.String dtd)
                            throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeEndDocument

public final void writeEndDocument()
                            throws javax.xml.stream.XMLStreamException

Specified by:

writeEndDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEndDocument

protected abstract void doWriteEndDocument()
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

internalGetPrefix

private java.lang.String internalGetPrefix(java.lang.String namespaceURI)
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public final void writeStartElement(java.lang.String prefix,
                                    java.lang.String localName,
                                    java.lang.String namespaceURI)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public final void writeStartElement(java.lang.String namespaceURI,
                                    java.lang.String localName)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartElement

protected abstract void doWriteStartElement(java.lang.String prefix,
                                            java.lang.String localName,
                                            java.lang.String namespaceURI)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public final void writeStartElement(java.lang.String localName)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartElement

protected abstract void doWriteStartElement(java.lang.String localName)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

public final void writeEndElement()
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeEndElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEndElement

protected abstract void doWriteEndElement()
                                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public final void writeEmptyElement(java.lang.String prefix,
                                    java.lang.String localName,
                                    java.lang.String namespaceURI)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public final void writeEmptyElement(java.lang.String namespaceURI,
                                    java.lang.String localName)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEmptyElement

protected abstract void doWriteEmptyElement(java.lang.String prefix,
                                            java.lang.String localName,
                                            java.lang.String namespaceURI)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public final void writeEmptyElement(java.lang.String localName)
                             throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEmptyElement

protected abstract void doWriteEmptyElement(java.lang.String localName)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public final void writeAttribute(java.lang.String prefix,
                                 java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String value)
                          throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public final void writeAttribute(java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String value)
                          throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteAttribute

protected abstract void doWriteAttribute(java.lang.String prefix,
                                         java.lang.String namespaceURI,
                                         java.lang.String localName,
                                         java.lang.String value)
                                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public final void writeAttribute(java.lang.String localName,
                                 java.lang.String value)
                          throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteAttribute

protected abstract void doWriteAttribute(java.lang.String localName,
                                         java.lang.String value)
                                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeNamespace

public final void writeNamespace(java.lang.String prefix,
                                 java.lang.String namespaceURI)
                          throws javax.xml.stream.XMLStreamException

Specified by:

writeNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteNamespace

protected abstract void doWriteNamespace(java.lang.String prefix,
                                         java.lang.String namespaceURI)
                                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeDefaultNamespace

public final void writeDefaultNamespace(java.lang.String namespaceURI)
                                 throws javax.xml.stream.XMLStreamException

Specified by:

writeDefaultNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteDefaultNamespace

protected abstract void doWriteDefaultNamespace(java.lang.String namespaceURI)
                                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public final void writeCharacters(char[] text,
                                  int start,
                                  int len)
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCharacters

protected abstract void doWriteCharacters(char[] text,
                                          int start,
                                          int len)
                                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public final void writeCharacters(java.lang.String text)
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCharacters

protected abstract void doWriteCharacters(java.lang.String text)
                                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeCData

public final void writeCData(java.lang.String data)
                      throws javax.xml.stream.XMLStreamException

Specified by:

writeCData in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCData

protected abstract void doWriteCData(java.lang.String data)
                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeComment

public final void writeComment(java.lang.String data)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeComment in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteComment

protected abstract void doWriteComment(java.lang.String data)
                                throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeEntityRef

public final void writeEntityRef(java.lang.String name)
                          throws javax.xml.stream.XMLStreamException

Specified by:

writeEntityRef in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEntityRef

protected abstract void doWriteEntityRef(java.lang.String name)
                                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public final void writeProcessingInstruction(java.lang.String target,
                                             java.lang.String data)
                                      throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteProcessingInstruction

protected abstract void doWriteProcessingInstruction(java.lang.String target,
                                                     java.lang.String data)
                                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public final void writeProcessingInstruction(java.lang.String target)
                                      throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteProcessingInstruction

protected abstract void doWriteProcessingInstruction(java.lang.String target)
                                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException