org.jdom2.input

类 StAXStreamWriter

java.lang.Object

org.jdom2.input.StAXStreamWriter

所有已实现的接口:

javax.xml.stream.XMLStreamWriter

public class StAXStreamWriter
extends java.lang.Object
implements javax.xml.stream.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().

从以下版本开始:

JDOM 2.1

作者:

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

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
void	close()
void	flush()
Document	getDocument() Gets the Document that was created by this writer.
javax.xml.namespace.NamespaceContext	getNamespaceContext()
java.lang.String	getPrefix(java.lang.String uri)
java.lang.Object	getProperty(java.lang.String name)
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[] chars, int start, int len)
void	writeCharacters(java.lang.String chars)
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)

从类继承的方法 java.lang.Object

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

构造器详细资料

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.

参数:

fac - The JDOMFactory to use.

repairnamespace - If true, then repair namespace errors.

方法详细资料

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.

返回:

The created Document

writeStartDocument

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

指定者:

writeStartDocument 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeStartDocument

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

指定者:

writeStartDocument 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeStartDocument

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

指定者:

writeStartDocument 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

setNamespaceContext

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

指定者:

setNamespaceContext 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

getPrefix

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

指定者:

getPrefix 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

setPrefix

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

指定者:

setPrefix 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

setDefaultNamespace

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

指定者:

setDefaultNamespace 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeDTD

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

指定者:

writeDTD 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeStartElement

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

指定者:

writeStartElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeStartElement

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

指定者:

writeStartElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeStartElement

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

指定者:

writeStartElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEmptyElement

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

指定者:

writeEmptyElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEmptyElement

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

指定者:

writeEmptyElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEmptyElement

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

指定者:

writeEmptyElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeDefaultNamespace

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

指定者:

writeDefaultNamespace 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeNamespace

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

指定者:

writeNamespace 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeAttribute

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

指定者:

writeAttribute 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeAttribute

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

指定者:

writeAttribute 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeAttribute

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

指定者:

writeAttribute 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeComment

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

指定者:

writeComment 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

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

指定者:

writeProcessingInstruction 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

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

指定者:

writeProcessingInstruction 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeCData

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

指定者:

writeCData 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEntityRef

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

指定者:

writeEntityRef 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeCharacters

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

指定者:

writeCharacters 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeCharacters

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

指定者:

writeCharacters 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEndElement

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

指定者:

writeEndElement 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

writeEndDocument

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

指定者:

writeEndDocument 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

close

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

指定者:

close 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

flush

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

指定者:

flush 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

javax.xml.stream.XMLStreamException

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()

指定者:

getNamespaceContext 在接口中 javax.xml.stream.XMLStreamWriter

getProperty

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

指定者:

getProperty 在接口中 javax.xml.stream.XMLStreamWriter

抛出:

java.lang.IllegalArgumentException