org.apache.axiom.util.stax.dialect

Class NamespaceContextCorrectingXMLStreamWriterWrapper

java.lang.Object

org.apache.axiom.util.stax.AbstractXMLStreamWriter

org.apache.axiom.util.stax.dialect.NamespaceContextCorrectingXMLStreamWriterWrapper

All Implemented Interfaces:

javax.xml.stream.XMLStreamWriter

class NamespaceContextCorrectingXMLStreamWriterWrapper
extends AbstractXMLStreamWriter

XMLStreamWriter wrapper that handles namespace bindings on behalf of the underlying writer. This wrapper can be used to correct two issues found in some stream writer implementations:

1. The writer doesn't correctly scope the namespace bindings. According to the StAX specifications, the scope of a namespace binding defined using XMLStreamWriter.setPrefix(String, String) or XMLStreamWriter.setDefaultNamespace(String) is limited to "the current START_ELEMENT / END_ELEMENT pair". Some implementations such as early versions of XL XP-J don't satisfy this requirement.
2. The writer doesn't handle masked prefixes correctly. To ensure consistent behavior in the presence of masked prefixes, the XMLStreamWriter.getPrefix(String) method (and the corresponding methods in the namespace context returned by XMLStreamWriter.getNamespaceContext()) must not return a prefix that is bound to a different namespace URI in a nested scope. Some implementations such as the StAX reference implementation fail to meet this requirement.

Invocations of the following methods will be completely processed by the wrapper, and will never reach the underlying writer:

• XMLStreamWriter.getNamespaceContext()
• XMLStreamWriter.setNamespaceContext(NamespaceContext)
• XMLStreamWriter.getPrefix(String)
• XMLStreamWriter.setDefaultNamespace(String)
• XMLStreamWriter.setPrefix(String, String)

The following methods rely on information from the namespace context to choose a the namespace prefix; the wrapper redirects invocations of these methods to the corresponding variants taking an explicit prefix parameter:

• XMLStreamWriter.writeStartElement(String, String)
• XMLStreamWriter.writeAttribute(String, String, String)
• XMLStreamWriter.writeEmptyElement(String, String)

This implies that if the wrapper is used, these methods will never be called on the underlying writer.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.xml.stream.XMLStreamWriter	parent

Constructor Summary

Constructors

Constructor and Description
NamespaceContextCorrectingXMLStreamWriterWrapper(javax.xml.stream.XMLStreamWriter parent)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doWriteAttribute(java.lang.String localName, java.lang.String value)
protected void	doWriteAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
protected void	doWriteCData(java.lang.String data)
protected void	doWriteCharacters(char[] text, int start, int len)
protected void	doWriteCharacters(java.lang.String text)
protected void	doWriteComment(java.lang.String data)
protected void	doWriteDefaultNamespace(java.lang.String namespaceURI)
protected void	doWriteDTD(java.lang.String dtd)
protected void	doWriteEmptyElement(java.lang.String localName)
protected void	doWriteEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
protected void	doWriteEndDocument()
protected void	doWriteEndElement()
protected void	doWriteEntityRef(java.lang.String name)
protected void	doWriteNamespace(java.lang.String prefix, java.lang.String namespaceURI)
protected void	doWriteProcessingInstruction(java.lang.String target)
protected void	doWriteProcessingInstruction(java.lang.String target, java.lang.String data)
protected void	doWriteStartDocument()
protected void	doWriteStartDocument(java.lang.String version)
protected void	doWriteStartDocument(java.lang.String encoding, java.lang.String version)
protected void	doWriteStartElement(java.lang.String localName)
protected void	doWriteStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void	flush()
java.lang.Object	getProperty(java.lang.String name)

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

Field Detail

parent

private final javax.xml.stream.XMLStreamWriter parent

Constructor Detail

NamespaceContextCorrectingXMLStreamWriterWrapper

public NamespaceContextCorrectingXMLStreamWriterWrapper(javax.xml.stream.XMLStreamWriter parent)

Method Detail

doWriteAttribute

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

Specified by:

doWriteAttribute in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteAttribute

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

Specified by:

doWriteAttribute in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCData

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

Specified by:

doWriteCData in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCharacters

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

Specified by:

doWriteCharacters in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteCharacters

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

Specified by:

doWriteCharacters in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteComment

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

Specified by:

doWriteComment in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteDefaultNamespace

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

Specified by:

doWriteDefaultNamespace in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteDTD

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

Specified by:

doWriteDTD in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEmptyElement

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

Specified by:

doWriteEmptyElement in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEmptyElement

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

Specified by:

doWriteEmptyElement in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEndDocument

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

Specified by:

doWriteEndDocument in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEndElement

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

Specified by:

doWriteEndElement in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteEntityRef

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

Specified by:

doWriteEntityRef in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteNamespace

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

Specified by:

doWriteNamespace in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteProcessingInstruction

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

Specified by:

doWriteProcessingInstruction in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteProcessingInstruction

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

Specified by:

doWriteProcessingInstruction in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

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

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

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

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartDocument

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

Specified by:

doWriteStartDocument in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartElement

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

Specified by:

doWriteStartElement in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

doWriteStartElement

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

Specified by:

doWriteStartElement in class AbstractXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

close

public void close()
           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

flush

public void flush()
           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException