Package org.jdom2.input
Class StAXStreamWriter
java.lang.Object
org.jdom2.input.StAXStreamWriter
- All Implemented Interfaces:
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
ConstructorsConstructorDescriptionCreate 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 TypeMethodDescriptionvoid
close()
void
flush()
Gets theDocument
that was created by this writer.getProperty
(String name) void
void
setNamespaceContext
(NamespaceContext context) void
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
void
writeEmptyElement
(String localName) void
writeEmptyElement
(String namespaceURI, String localName) void
writeEmptyElement
(String prefix, String localName, String namespaceURI) void
void
void
writeEntityRef
(String name) void
writeNamespace
(String prefix, String namespaceURI) void
writeProcessingInstruction
(String target) void
writeProcessingInstruction
(String target, String data) void
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)
-
Constructor Details
-
StAXStreamWriter
public StAXStreamWriter()Create a StAXStreamWriter with the default JDOMFactory for creating JDOM Content. -
StAXStreamWriter
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
Gets theDocument
that was created by this writer. Only available afterwriteEndDocument()
has been called, and before the Writer is closed.- Returns:
- The created
Document
-
writeStartDocument
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setNamespaceContext
- Specified by:
setNamespaceContext
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
getPrefix
- Specified by:
getPrefix
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setPrefix
- Specified by:
setPrefix
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setDefaultNamespace
- Specified by:
setDefaultNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeDTD
- Specified by:
writeDTD
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException - Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException - Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeDefaultNamespace
- Specified by:
writeDefaultNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeNamespace
- Specified by:
writeNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
- Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException - Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException - Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeComment
- Specified by:
writeComment
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCData
- Specified by:
writeCData
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEntityRef
- Specified by:
writeEntityRef
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEndElement
- Specified by:
writeEndElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEndDocument
- Specified by:
writeEndDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
close
- Specified by:
close
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
flush
- Specified by:
flush
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
getNamespaceContext
- Specified by:
getNamespaceContext
in interfaceXMLStreamWriter
-
getProperty
- Specified by:
getProperty
in interfaceXMLStreamWriter
- Throws:
IllegalArgumentException
-