Package org.jdom2.input

Class StAXStreamWriter

java.lang.Object

org.jdom2.input.StAXStreamWriter

All Implemented Interfaces:

XMLStreamWriter

public class StAXStreamWriter
extends Object
implements XMLStreamWriter

An XMLStreamWriter implementation that writes XML data to a new JDOM Document. The document can be retrieved using getDocument().

This class is the inverse of the class StAXStreamBuilder in the sense that this class is written to (it's an XMLStreamWriter implementation) to create a JDOM Document whereas the StAXStreamBuilder reads from a user-supplied XMLStreamReader. It is the difference between a 'push' concept and a 'pull' concept.

An interesting read for people using this class: Apache Axiom notes on setPrefix().

Since:

JDOM 2.1

Author:

gordon burgett https://github.com/gburgett, Rolf Lear

Constructor Summary

Constructors

Constructor	Description
StAXStreamWriter()	Create a StAXStreamWriter with the default JDOMFactory for creating JDOM Content.
StAXStreamWriter(JDOMFactory fac, boolean repairnamespace)	Create a StAXStreamWriter with the specified JDOMFactory for creating JDOM Content.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
Document	getDocument()	Gets the Document that was created by this writer.
NamespaceContext	getNamespaceContext()
String	getPrefix(String uri)
Object	getProperty(String name)
void	setDefaultNamespace(String uri)
void	setNamespaceContext(NamespaceContext context)
void	setPrefix(String prefix, String uri)
void	writeAttribute(String localName, String value)
void	writeAttribute(String namespaceURI, String localName, String value)
void	writeAttribute(String prefix, String namespaceURI, String localName, String value)
void	writeCData(String data)
void	writeCharacters(char[] chars, int start, int len)
void	writeCharacters(String chars)
void	writeComment(String data)
void	writeDefaultNamespace(String namespaceURI)
void	writeDTD(String dtd)
void	writeEmptyElement(String localName)
void	writeEmptyElement(String namespaceURI, String localName)
void	writeEmptyElement(String prefix, String localName, String namespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String name)
void	writeNamespace(String prefix, String namespaceURI)
void	writeProcessingInstruction(String target)
void	writeProcessingInstruction(String target, String data)
void	writeStartDocument()
void	writeStartDocument(String version)
void	writeStartDocument(String encoding, String version)
void	writeStartElement(String localName)
void	writeStartElement(String namespaceURI, String localName)
void	writeStartElement(String prefix, String localName, String namespaceURI)

Methods inherited from class java.lang.Object

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

Constructor Details

StAXStreamWriter

public StAXStreamWriter()

Create a StAXStreamWriter with the default JDOMFactory for creating JDOM Content.

StAXStreamWriter

public StAXStreamWriter(JDOMFactory fac,
 boolean repairnamespace)

Create a StAXStreamWriter with the specified JDOMFactory for creating JDOM Content.

Parameters:

fac - The JDOMFactory to use.

repairnamespace - If true, then repair namespace errors.

Method Details

getDocument

public Document getDocument()

Gets the Document that was created by this writer. Only available after writeEndDocument() has been called, and before the Writer is closed.

Returns:

The created Document

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String encoding,
 String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Specified by:

setNamespaceContext in interface XMLStreamWriter

Throws:

XMLStreamException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Specified by:

getPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setPrefix

public void setPrefix(String prefix,
 String uri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
 String localName,
 String namespaceURI)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
 String localName,
 String namespaceURI)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(String prefix,
 String namespaceURI)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String namespaceURI,
 String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String prefix,
 String namespaceURI,
 String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
 String data)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String chars)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] chars,
 int start,
 int len)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamWriter

Throws:

IllegalArgumentException