compact2, compact3

javax.xml.stream

Interface XMLEventWriter

All Superinterfaces:

XMLEventConsumer

public interface XMLEventWriter
extends XMLEventConsumer

这是编写XML文档的顶级接口。此接口的实例不需要验证XML的形式。

从以下版本开始：

一点六

Version:

一

另请参见：

XMLEventReader， XMLEvent， Characters， ProcessingInstruction， StartElement， EndElement

方法摘要

Modifier and Type	Method and Description
void	add(XMLEvent event) 事件添加到输出流中加入start_element将打开一个新的命名空间范围将被关闭时，相应的end_element写。
void	add(XMLEventReader reader) 增加了一个整流输出流，呼吁InputStream的说法next()直到hasnext()返回false，这应该被视为一个方便的方法，将执行以下在一个事件的读者和调用所有的事件循环加上每个事件。
void	close() 释放与此流关联的任何资源
void	flush() 将任何缓存事件写入到底层输出机制
NamespaceContext	getNamespaceContext() 返回当前命名空间上下文。
String	getPrefix(String uri) 获取前缀的URI是必然的
void	setDefaultNamespace(String uri) 绑定一个默认的命名空间URI的URI，这必将在当前start_element / end_element对范围。
void	setNamespaceContext(NamespaceContext context) 设置当前的命名空间的前缀和URI绑定上下文。
void	setPrefix(String prefix, String uri) 设置前缀的URI是必然的。

方法详细信息

flush

void flush()
    throws XMLStreamException

将任何缓存事件写入到底层输出机制

异常

XMLStreamException

close

void close()
    throws XMLStreamException

释放与此流关联的任何资源

异常

XMLStreamException

add

void add(XMLEvent event)
  throws XMLStreamException

事件添加到输出流中加入start_element将打开一个新的命名空间范围将被关闭时，相应的end_element写。

Required and optional fields for events added to the writer
Event Type	Required Fields	Optional Fields	Required Behavior
START_ELEMENT	QName name	namespaces , attributes	A START_ELEMENT will be written by writing the name, namespaces, and attributes of the event in XML 1.0 valid syntax for START_ELEMENTs. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. Each attribute (if any) is written using the behavior specified in the attribute section of this table. Each namespace (if any) is written using the behavior specified in the namespace section of this table.
END_ELEMENT	Qname name	None	A well formed END_ELEMENT tag is written. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. If the END_ELEMENT name does not match the START_ELEMENT name an XMLStreamException is thrown.
ATTRIBUTE	QName name , String value	QName type	An attribute is written using the same algorithm to find the lexical form as used in START_ELEMENT. The default is to use double quotes to wrap attribute values and to escape any double quotes found in the value. The type value is ignored.
NAMESPACE	String prefix, String namespaceURI, boolean isDefaultNamespaceDeclaration	None	A namespace declaration is written. If the namespace is a default namespace declaration (isDefault is true) then xmlns="$namespaceURI" is written and the prefix is optional. If isDefault is false, the prefix must be declared and the writer must prepend xmlns to the prefix and write out a standard prefix declaration.
PROCESSING_INSTRUCTION	None	String target, String data	The data does not need to be present and may be null. Target is required and many not be null. The writer will write data section directly after the target, enclosed in appropriate XML 1.0 syntax
COMMENT	None	String comment	If the comment is present (not null) it is written, otherwise an an empty comment is written
START_DOCUMENT	None	String encoding , boolean standalone, String version	A START_DOCUMENT event is not required to be written to the stream. If present the attributes are written inside the appropriate XML declaration syntax
END_DOCUMENT	None	None	Nothing is written to the output
DTD	String DocumentTypeDefinition	None	The DocumentTypeDefinition is written to the output

Specified by:

add 接口 XMLEventConsumer

参数

event -事件被添加

异常

XMLStreamException

add

void add(XMLEventReader reader)
  throws XMLStreamException

增加了一个整流输出流，呼吁InputStream的说法next()直到hasnext()返回false，这应该被视为一个方便的方法，将执行以下在一个事件的读者和调用所有的事件循环加上每个事件。

参数

reader的事件流添加到输出

异常

XMLStreamException

getPrefix

String getPrefix(String uri)
          throws XMLStreamException

获取前缀的URI是必然的

参数

uri - 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将绑定命名空间使用上下文来解决命名空间根上下文传递给方法。

参数

context -命名空间上下文使用这个作家

异常

XMLStreamException

getNamespaceContext

NamespaceContext getNamespaceContext()

返回当前命名空间上下文。

结果

当前命名空间上下文