XMLStreamWriter (Java Platform SE 8 )

public interface XMLStreamWriter

该接口指定如何编写XML XMLStreamWriter。不执行的XMLStreamWriter其输入合法性检查。然而，writecharacters方法需要逃避， <和> 属性值的writeattribute方法将逃脱的上述特点，加上“确保所有文字内容和属性值的形成。每个命名空间和属性必须单独写入。

XML Namespaces, `javax.xml.stream.isRepairingNamespaces` and write method behaviour
方法	`isRepairingNamespaces` == true		`isRepairingNamespaces` == false
	namespaceURI bound	namespaceURI unbound	namespaceURI bound	namespaceURI unbound
`writeAttribute(namespaceURI, localName, value)`	prefix:localName="value" ^[1]	xmlns:{generated}="namespaceURI" {generated}:localName="value"	prefix:localName="value" ^[1]	`XMLStreamException`
`writeAttribute(prefix, namespaceURI, localName, value)`	bound to same prefix: prefix:localName="value" ^[1] bound to different prefix: xmlns:{generated}="namespaceURI" {generated}:localName="value"	xmlns:prefix="namespaceURI" prefix:localName="value" ^[3]	bound to same prefix: prefix:localName="value" ^[1][2] bound to different prefix: `XMLStreamException`^[2]	xmlns:prefix="namespaceURI" prefix:localName="value" ^[2][5]
`writeStartElement(namespaceURI, localName)` `writeEmptyElement(namespaceURI, localName)`	<prefix:localName> ^[1]	<{generated}:localName xmlns:{generated}="namespaceURI">	<prefix:localName> ^[1]	`XMLStreamException`
`writeStartElement(prefix, localName, namespaceURI)` `writeEmptyElement(prefix, localName, namespaceURI)`	bound to same prefix: <prefix:localName> ^[1] bound to different prefix: <{generated}:localName xmlns:{generated}="namespaceURI">	<prefix:localName xmlns:prefix="namespaceURI"> ^[4]	bound to same prefix: <prefix:localName> ^[1] bound to different prefix: `XMLStreamException`	<prefix:localName>
Notes: [1] if namespaceURI == default Namespace URI, then no prefix is written [2] if prefix == "" \|\| null && namespaceURI == "", then no prefix or Namespace declaration is generated or written [3] if prefix == "" \|\| null, then a prefix is randomly generated [4] if prefix == "" \|\| null, then it is treated as the default Namespace and no prefix is generated or written, an xmlns declaration is generated and written if the namespaceURI is unbound [5] if prefix == "" \|\| null, then it is treated as an invalid attempt to define the default Namespace and an XMLStreamException is thrown

从以下版本开始：: 一点六
Version:: 一
另请参见：: XMLOutputFactory， XMLStreamReader

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`void`	`close()` 关闭这个作家，并释放与作者相关的任何资源。
`void`	`flush()` 将任何缓存数据写入到底层输出机制。
`NamespaceContext`	`getNamespaceContext()` 返回当前命名空间上下文。
`String`	`getPrefix(String uri)` 获取前缀的URI是必然的
`Object`	`getProperty(String name)` 从底层实现获取一个功能/属性的值
`void`	`setDefaultNamespace(String uri)` 绑定一个默认的命名空间URI的URI，这必将在当前start_element / end_element对范围。
`void`	`setNamespaceContext(NamespaceContext context)` 设置当前的命名空间的前缀和URI绑定上下文。
`void`	`setPrefix(String prefix, String uri)` 设置前缀的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)` 写一个CDATA部分
`void`	`writeCharacters(char[] text, int start, int len)` 写入输出的文本
`void`	`writeCharacters(String text)` 写入输出的文本
`void`	`writeComment(String data)` 用封闭的数据写入XML注释
`void`	`writeDefaultNamespace(String namespaceURI)` 将默认命名空间写入流
`void`	`writeDTD(String dtd)` 写一个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)` 写一个命名空间输出流如果前缀论证方法是空字符串，“xmlns”，或空的方法将委托writedefaultnamespace
`void`	`writeProcessingInstruction(String target)` 写一个处理指令
`void`	`writeProcessingInstruction(String target, String data)` 写一个处理指令
`void`	`writeStartDocument()` 写XML声明。
`void`	`writeStartDocument(String version)` 写XML声明。
`void`	`writeStartDocument(String encoding, String version)` 写XML声明。
`void`	`writeStartElement(String localName)` 将开始标记写入输出。
`void`	`writeStartElement(String namespaceURI, String localName)` 将开始标记写入输出
`void`	`writeStartElement(String prefix, String localName, String namespaceURI)` 将开始标记写入输出

- 方法详细信息
  - writeStartElement
```
void writeStartElement(String localName)
                throws XMLStreamException
```
    将开始标记写入输出。所有的内部空间的上下文关联起来的方法打开一个新的范围。编写相应的范围要关闭EndElement原因。
    
    参数
    
    localName -标签的本地名称，不得空
    
    异常
    
    XMLStreamException
  - writeStartElement
```
void writeStartElement(String namespaceURI,
                       String localName)
                throws XMLStreamException
```
    将开始标记写入输出
    
    参数
    
    namespaceURI -前缀使用namespaceuri，不得空
    
    localName -标签的本地名称，不得空
    
    异常
    
    XMLStreamException如果命名空间URI没有绑定到一个前缀和javax.xml.stream.isrepairingnamespaces尚未设置为true
  - writeStartElement
```
void writeStartElement(String prefix,
                       String localName,
                       String namespaceURI)
                throws XMLStreamException
```
    将开始标记写入输出
    
    参数
    
    localName -标签的本地名称，不得空
    
    prefix -标签的前缀，不得空
    
    namespaceURI - URI绑定前缀，不得空
    
    异常
    
    XMLStreamException
  - writeEmptyElement
```
void writeEmptyElement(String namespaceURI,
                       String localName)
                throws XMLStreamException
```
    将一个空元素标记写入输出
    
    参数
    
    namespaceURI - URI绑定标签，不得空
    
    localName -标签的本地名称，不得空
    
    异常
    
    XMLStreamException如果命名空间URI没有绑定到一个前缀和javax.xml.stream.isrepairingnamespaces尚未设置为true
  - writeEmptyElement
```
void writeEmptyElement(String prefix,
                       String localName,
                       String namespaceURI)
                throws XMLStreamException
```
    将一个空元素标记写入输出
    
    参数
    
    prefix -标签的前缀，不得空
    
    localName -标签的本地名称，不得空
    
    namespaceURI - URI绑定标签，不得空
    
    异常
    
    XMLStreamException
  - writeEmptyElement
```
void writeEmptyElement(String localName)
                throws XMLStreamException
```
    将一个空元素标记写入输出
    
    参数
    
    localName -标签的本地名称，不得空
    
    异常
    
    XMLStreamException
  - writeEndElement
```
void writeEndElement()
              throws XMLStreamException
```
    将结束标记写入依赖于写作者的内部状态，以确定事件的前缀和本地名称。
    
    异常
    
    XMLStreamException
  - writeEndDocument
```
void writeEndDocument()
               throws XMLStreamException
```
    关闭任何开始标记并写入相应的结束标记。
    
    异常
    
    XMLStreamException
  - close
```
void close()
    throws XMLStreamException
```
    关闭这个作家，并释放与作者相关的任何资源。这不能关闭底层的输出流。
    
    异常
    
    XMLStreamException
  - flush
```
void flush()
    throws XMLStreamException
```
    将任何缓存数据写入到底层输出机制。
    
    异常
    
    XMLStreamException
  - writeAttribute
```
void writeAttribute(String localName,
                    String value)
             throws XMLStreamException
```
    在没有前缀的情况下将一个属性写入到输出流中。
    
    参数
    
    localName -属性的本地名称
    
    value -该属性的值
    
    异常
    
    IllegalStateException -如果当前状态不允许属性的写作
    
    XMLStreamException
  - writeAttribute
```
void writeAttribute(String prefix,
                    String namespaceURI,
                    String localName,
                    String value)
             throws XMLStreamException
```
    将属性写入输出流
    
    参数
    
    prefix -这个属性的前缀
    
    namespaceURI -此属性的前缀的URI
    
    localName -属性的本地名称
    
    value -该属性的值
    
    异常
    
    IllegalStateException -如果当前状态不允许属性的写作
    
    XMLStreamException如果命名空间URI没有绑定到一个前缀和javax.xml.stream.isrepairingnamespaces尚未设置为true
  - writeAttribute
```
void writeAttribute(String namespaceURI,
                    String localName,
                    String value)
             throws XMLStreamException
```
    将属性写入输出流
    
    参数
    
    namespaceURI -此属性的前缀的URI
    
    localName -属性的本地名称
    
    value -该属性的值
    
    异常
    
    IllegalStateException -如果当前状态不允许属性的写作
    
    XMLStreamException如果命名空间URI没有绑定到一个前缀和javax.xml.stream.isrepairingnamespaces尚未设置为true
  - writeNamespace
```
void writeNamespace(String prefix,
                    String namespaceURI)
             throws XMLStreamException
```
    写一个命名空间输出流如果前缀论证方法是空字符串，“xmlns”，或空的方法将委托writedefaultnamespace
    
    参数
    
    prefix -绑定命名空间前缀
    
    namespaceURI - URI绑定前缀
    
    异常
    
    IllegalStateException -如果当前状态不允许命名空间写作
    
    XMLStreamException
  - writeDefaultNamespace
```
void writeDefaultNamespace(String namespaceURI)
                    throws XMLStreamException
```
    将默认命名空间写入流
    
    参数
    
    namespaceURI - URI绑定默认命名空间
    
    异常
    
    IllegalStateException -如果当前状态不允许命名空间写作
    
    XMLStreamException
  - writeComment
```
void writeComment(String data)
           throws XMLStreamException
```
    用封闭的数据写入XML注释
    
    参数
    
    包含在评论 data的数据，可能是空的
    
    异常
    
    XMLStreamException
  - writeProcessingInstruction
```
void writeProcessingInstruction(String target)
                         throws XMLStreamException
```
    写一个处理指令
    
    参数
    
    target -处理指令的目标，不可能是空的
    
    异常
    
    XMLStreamException
  - writeProcessingInstruction
```
void writeProcessingInstruction(String target,
                                String data)
                         throws XMLStreamException
```
    写一个处理指令
    
    参数
    
    target -处理指令的目标，不可能是空的
    
    包含在处理指令 data -数据，不得空
    
    异常
    
    XMLStreamException
  - writeCData
```
void writeCData(String data)
         throws XMLStreamException
```
    写一个CDATA部分
    
    参数
    
    包含在CDATA部分 data -数据，不得空
    
    异常
    
    XMLStreamException
  - writeDTD
```
void writeDTD(String dtd)
       throws XMLStreamException
```
    写一个DTD部分。这个字符串代表整个doctypedecl生产从XML 1规范。
    
    参数
    
    dtd的DTD来写的
    
    异常
    
    XMLStreamException
  - writeEntityRef
```
void writeEntityRef(String name)
             throws XMLStreamException
```
    写入实体引用
    
    参数
    
    name -单位名称
    
    异常
    
    XMLStreamException
  - writeStartDocument
```
void writeStartDocument()
                 throws XMLStreamException
```
    写XML声明。默认为1的XML版本，和编码为UTF-8
    
    异常
    
    XMLStreamException
  - writeStartDocument
```
void writeStartDocument(String version)
                 throws XMLStreamException
```
    写XML声明。默认XML版本到1
    
    参数
    
    version对XML文档的版本
    
    异常
    
    XMLStreamException
  - writeStartDocument
```
void writeStartDocument(String encoding,
                        String version)
                 throws XMLStreamException
```
    写XML声明。请注意，编码参数不设置潜在输出的实际编码。必须设置在XMLStreamWriter实例使用xmloutputfactory创建
    
    参数
    
    encoding - XML声明的编码
    
    version对XML文档的版本
    
    异常
    
    XMLStreamException -如果编码不匹配的基本流编码
  - writeCharacters
```
void writeCharacters(String text)
              throws XMLStreamException
```
    写入输出的文本
    
    参数
    
    text价值-写
    
    异常
    
    XMLStreamException
  - writeCharacters
```
void writeCharacters(char[] text,
                     int start,
                     int len)
              throws XMLStreamException
```
    写入输出的文本
    
    参数
    
    text价值-写
    
    start -数组中的起始位置
    
    len -数目字写
    
    异常
    
    XMLStreamException
  - getPrefix
```
String getPrefix(String uri)
          throws XMLStreamException
```
    获取前缀的URI是必然的
    
    结果
    
    前缀或空
    
    异常
    
    XMLStreamException
  - setPrefix
```
void setPrefix(String prefix,
               String uri)
        throws XMLStreamException
```
    设置前缀的URI是必然的。此前缀绑定在当前start_element / end_element对范围。如果这种方法是在start_element已经写的前缀名为绑定在根的范围。
    
    参数
    
    prefix -前缀绑定到URI，不得空
    
    uri - URI绑定前缀，可能是空的
    
    异常
    
    XMLStreamException
  - setDefaultNamespace
```
void setDefaultNamespace(String uri)
                  throws XMLStreamException
```
    绑定一个默认的命名空间URI的URI，这必将在当前start_element / end_element对范围。如果这个方法之前已经写了start_element URI称是绑定在根的范围。
    
    参数
    
    uri - URI绑定到默认的命名空间，可能是空的
    
    异常
    
    XMLStreamException
  - setNamespaceContext
```
void setNamespaceContext(NamespaceContext context)
                  throws XMLStreamException
```
    设置当前的命名空间的前缀和URI绑定上下文。此上下文成为写入的根命名空间上下文，并将取代当前的根命名空间上下文。随后调用setPrefix和setDefaultNamespace将绑定命名空间使用上下文来解决命名空间根上下文传递给方法。此方法只能在文档开始时调用一次。它不会导致命名空间声明。如果一个命名空间URI前缀映射在命名空间上下文作为申报和前缀可以使用StreamWriter的发现。
    
    参数
    
    context -命名空间上下文使用这个作家，不得空
    
    异常
    
    XMLStreamException
  - getNamespaceContext
```
NamespaceContext getNamespaceContext()
```
    返回当前命名空间上下文。
    
    结果
    
    目前NamespaceContext
  - getProperty
```
Object getProperty(String name)
            throws IllegalArgumentException
```
    从底层实现获取一个功能/属性的值
    
    参数
    
    name -属性的名称，不得空
    
    结果
    
    属性的值
    
    异常
    
    IllegalArgumentException如果物业不支持
    
    NullPointerException -如果名称是空的

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface XMLStreamWriter

方法摘要

方法详细信息

writeStartElement

writeStartElement

writeStartElement

writeEmptyElement

writeEmptyElement

writeEmptyElement

writeEndElement

writeEndDocument

close

flush

writeAttribute

writeAttribute

writeAttribute

writeNamespace

writeDefaultNamespace

writeComment

writeProcessingInstruction

writeProcessingInstruction

writeCData

writeDTD

writeEntityRef

writeStartDocument

writeStartDocument

writeStartDocument

writeCharacters

writeCharacters

getPrefix

setPrefix

setDefaultNamespace

setNamespaceContext

getNamespaceContext

getProperty