javax.xml.stream.events

接口

javax.xml.stream.events
接口 XMLEvent

所有超级接口：
XMLStreamConstants
所有已知子接口：
Attribute, Characters, Comment, DTD, EndDocument, EndElement, EntityDeclaration, EntityReference, Namespace, NotationDeclaration, ProcessingInstruction, StartDocument, StartElement 
public interface XMLEvent
     

      extends 
      XMLStreamConstants

处理标记事件的基础事件接口。事件是用来与应用程序交流 XML 1.0 InfoSet 的 value 对象。可以在解析完事件之后缓存和引用事件。

从以下版本开始：
1.6
另请参见：
XMLEventReader, Characters, ProcessingInstruction, StartElement, EndElement, StartDocument, EndDocument, EntityReference, EntityDeclaration, NotationDeclaration

字段摘要
 
从接口 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
 
方法摘要
 Characters asCharacters()
          将此事件作为 Characters 返回，如果此事件不是字符，则可能导致类强制转化异常。
 EndElement asEndElement()
          将此事件作为结束元素事件返回，如果此事件不是结束元素，则可能导致类强制转换异常。
 StartElement asStartElement()
          将此事件作为开始元素事件返回，如果此事件不是开始元素，则可能导致类强制转换异常。
 int getEventType()
          返回此事件的整数码。
 Location getLocation()
          返回此事件的位置。
 QName getSchemaType()
          提供此方法是为了提供有关关联事件的可选类型信息。
 boolean isAttribute()
          检查此事件是否为 Attribute 的实用工具函数。
 boolean isCharacters()
          检查此事件是否为 Characters 的实用工具函数。
 boolean isEndDocument()
          检查此事件是否为 EndDocument 的实用工具函数。
 boolean isEndElement()
          检查此事件是否为 EndElement 的实用工具函数。
 boolean isEntityReference()
          检查此事件是否为 EntityReference 的实用工具函数。
 boolean isNamespace()
          检查此事件是否为 Namespace 的实用工具函数。
 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 是不易改变的，将保留其信息。

另请参见：
Location

isStartElement

boolean isStartElement()
检查此事件是否为 StartElement 的实用工具函数。

另请参见：
StartElement

isAttribute

boolean isAttribute()
检查此事件是否为 Attribute 的实用工具函数。

另请参见：
Attribute

isNamespace

boolean isNamespace()
检查此事件是否为 Namespace 的实用工具函数。

另请参见：
Namespace

isEndElement

boolean isEndElement()
检查此事件是否为 EndElement 的实用工具函数。

另请参见：
EndElement

isEntityReference

boolean isEntityReference()
检查此事件是否为 EntityReference 的实用工具函数。

另请参见：
EntityReference

isProcessingInstruction

boolean isProcessingInstruction()
检查此事件是否为 ProcessingInstruction 的实用工具函数。

另请参见：
ProcessingInstruction

isCharacters

boolean isCharacters()
检查此事件是否为 Characters 的实用工具函数。

另请参见：
Characters

isStartDocument

boolean isStartDocument()
检查此事件是否为 StartDocument 的实用工具函数。

另请参见：
StartDocument

isEndDocument

boolean isEndDocument()
检查此事件是否为 EndDocument 的实用工具函数。

另请参见：
EndDocument

asStartElement

StartElement asStartElement()
将此事件作为开始元素事件返回，如果此事件不是开始元素，则可能导致类强制转换异常。

asEndElement

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

asCharacters

Characters asCharacters()
将此事件作为 Characters 返回，如果此事件不是字符，则可能导致类强制转化异常。

getSchemaType

QName getSchemaType()
提供此方法是为了提供有关关联事件的可选类型信息。信息是可选的，如果没有可用信息，则返回 null。

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer)
                           throws XMLStreamException
此方法根据 XML 1.0 规范将 XMLEvent 编写为 Unicode 字符。不应输出缩排或空格。 在将任何用户定义的事件类型写入输出流时，都应当调用此方法。内置 Event 类型必须实现此方法，但是在将内置 Event 写出到输出流时，为了优化目的，可以选择而不调用这些方法。生成的输出必须与所表示的信息集等效。

参数：
writer - 将输出数据的编写器
抛出：
XMLStreamException - 如果在写入事件时发生严重错误