compact2, compact3

javax.xml.stream.events

Interface XMLEvent

All Superinterfaces:

XMLStreamConstants

All Known Subinterfaces:

Attribute ， Characters ， Comment ， DTD ， EndDocument ， EndElement ， EntityDeclaration ， EntityReference ， Namespace ， NotationDeclaration ， ProcessingInstruction ， StartDocument ， StartElement

public interface XMLEvent
extends XMLStreamConstants

这是处理标记事件的基本事件界面。 事件是用于将XML 1.0 InfoSet传递给应用程序的值对象。 解析完成后，可能会缓存和引用事件。

从以下版本开始：

1.6

Version:

1.0

另请参见：

XMLEventReader ， Characters ， ProcessingInstruction ， StartElement ， EndElement ， StartDocument ， EndDocument ， EntityReference ， EntityDeclaration ， NotationDeclaration

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

方法摘要

Modifier and Type	Method and Description
Characters	asCharacters() 将此事件作为Characters返回，如果此事件不是Characters，可能会导致类转换异常。
EndElement	asEndElement() 将此事件作为结束元素事件返回，如果此事件不是结束元素，则可能会导致类转换异常。
StartElement	asStartElement() 将此事件作为起始元素事件返回，如果此事件不是起始元素，则可能会导致类转换异常。
int	getEventType() 返回此事件的整数代码。
Location	getLocation() 返回此事件的位置。
QName	getSchemaType() 提供了该方法用于实现以提供关于事件的可选类型信息。
boolean	isAttribute() 一个效用函数来检查这个事件是否是属性。
boolean	isCharacters() 一个效用函数来检查这个事件是否是字符。
boolean	isEndDocument() 一个效用函数来检查这个事件是否是一个EndDocument。
boolean	isEndElement() 一个效用函数来检查这个事件是否是EndElement。
boolean	isEntityReference() 一个效用函数来检查这个事件是否是一个EntityReference。
boolean	isNamespace() 一个效用函数来检查这个事件是否是一个命名空间。
boolean	isProcessingInstruction() 一个效用函数来检查这个事件是否是ProcessingInstruction。
boolean	isStartDocument() 一个效用函数来检查这个事件是否是一个StartDocument。
boolean	isStartElement() 一个效用函数来检查这个事件是否是一个StartElement。
void	writeAsEncodedUnicode(Writer writer) 该方法将按照XML 1.0规范将XMLEvent写为Unicode字符。

方法详细信息

getEventType

int getEventType()

返回此事件的整数代码。

另请参见：

XMLStreamConstants.START_ELEMENT ， XMLStreamConstants.END_ELEMENT ， XMLStreamConstants.CHARACTERS ， XMLStreamConstants.ATTRIBUTE ， XMLStreamConstants.NAMESPACE ， XMLStreamConstants.PROCESSING_INSTRUCTION ， XMLStreamConstants.COMMENT ， XMLStreamConstants.START_DOCUMENT ， XMLStreamConstants.END_DOCUMENT ， XMLStreamConstants.DTD

getLocation

Location getLocation()

返回此事件的位置。 从该方法返回的位置是非易失性的，并将保留其信息。

另请参见：

Location

isStartElement

boolean isStartElement()

一个效用函数来检查这个事件是否是一个StartElement。

另请参见：

StartElement

isAttribute

boolean isAttribute()

一个效用函数来检查这个事件是否是属性。

另请参见：

Attribute

isNamespace

boolean isNamespace()

一个效用函数来检查这个事件是否是一个命名空间。

另请参见：

Namespace

isEndElement

boolean isEndElement()

一个效用函数来检查这个事件是否是EndElement。

另请参见：

EndElement

isEntityReference

boolean isEntityReference()

一个效用函数来检查这个事件是否是一个EntityReference。

另请参见：

EntityReference

isProcessingInstruction

boolean isProcessingInstruction()

一个效用函数来检查这个事件是否是ProcessingInstruction。

另请参见：

ProcessingInstruction

isCharacters

boolean isCharacters()

一个效用函数来检查这个事件是否是字符。

另请参见：

Characters

isStartDocument

boolean isStartDocument()

一个效用函数来检查这个事件是否是一个StartDocument。

另请参见：

StartDocument

isEndDocument

boolean isEndDocument()

一个效用函数来检查这个事件是否是一个EndDocument。

另请参见：

EndDocument

asStartElement

StartElement asStartElement()

将此事件作为起始元素事件返回，如果此事件不是起始元素，则可能会导致类转换异常。

asEndElement

EndElement asEndElement()

将此事件作为结束元素事件返回，如果此事件不是结束元素，则可能会导致类转换异常。

asCharacters

Characters asCharacters()

将此事件作为Characters返回，如果此事件不是Characters，可能会导致类转换异常。

getSchemaType

QName getSchemaType()

提供了该方法用于实现以提供关于事件的可选类型信息。 它是可选的，如果没有可用信息将返回null。

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer)
                    throws XMLStreamException

该方法将按照XML 1.0规范将XMLEvent写为Unicode字符。 不输出缩进或空格。 任何用户定义的事件类型在写入输出流时都应该调用此方法。 内置事件类型必须实现此方法，但实现可以选择不将这些方法调用这些方法，以便在将事件内置到输出流时进行优化。 所产生的输出必须在表达的信息集方面相当。

参数

writer - 将输出数据的作者

异常

XMLStreamException - 如果写入事件有致命错误