- 所有超级接口:
-
XMLStreamConstants
- 所有已知子接口:
-
Attribute
,Characters
,Comment
,DTD
,EndDocument
,EndElement
,EntityDeclaration
,EntityReference
,Namespace
,NotationDeclaration
,ProcessingInstruction
,StartDocument
,StartElement
这是处理标记事件的基本事件接口。事件是用于将 XML 1.0 InfoSet 传达给应用程序的值对象。事件可能在解析完成后被缓存和引用。
- 自:
- 1.6
- 另请参阅:
-
Field Summary
Fields declared in 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
-
Method Summary
Modifier and TypeMethodDescription将此事件作为 Characters 返回,如果此事件不是 Characters,则可能导致类转换异常。将此事件作为结束元素事件返回,如果此事件不是结束元素,则可能导致类转换异常。将此事件作为开始元素事件返回,如果此事件不是开始元素,则可能导致类转换异常。int
返回此事件的整数代码。返回此事件的位置。此方法由实现提供,用于提供有关关联事件的可选类型信息。boolean
用于检查此事件是否为 Attribute 的实用函数。boolean
用于检查此事件是否为 Characters 的实用函数。boolean
用于检查此事件是否为 EndDocument 的实用函数。boolean
用于检查此事件是否为 EndElement 的实用函数。boolean
用于检查此事件是否为 EntityReference 的实用函数。boolean
用于检查此事件是否为 Namespace 的实用函数。boolean
用于检查此事件是否为 ProcessingInstruction 的实用函数。boolean
用于检查此事件是否为 StartDocument 的实用函数。boolean
用于检查此事件是否为 StartElement 的实用函数。void
writeAsEncodedUnicode
(Writer writer) 此方法将按照 XML 1.0 规范将 XMLEvent 写入为 Unicode 字符。
-
Method Details
-
getEventType
int getEventType()返回此事件的整数代码。- 返回:
- 事件类型
- 另请参阅:
-
getLocation
Location getLocation()返回此事件的位置。从此方法返回的 Location 是非易失性的,并将保留其信息。- 返回:
- 事件的位置
- 另请参阅:
-
isStartElement
boolean isStartElement()用于检查此事件是否为 StartElement 的实用函数。- 返回:
-
如果事件是
StartElement
,则返回 true,否则返回 false - 另请参阅:
-
isAttribute
boolean isAttribute()用于检查此事件是否为 Attribute 的实用函数。- 返回:
-
如果事件是
Attribute
,则返回 true,否则返回 false - 另请参阅:
-
isNamespace
boolean isNamespace()用于检查此事件是否为 Namespace 的实用函数。- 返回:
-
如果事件是
Namespace
,则返回 true,否则返回 false - 另请参阅:
-
isEndElement
boolean isEndElement()用于检查此事件是否为 EndElement 的实用函数。- 返回:
-
如果事件是
EndElement
,则返回 true,否则返回 false - 另请参阅:
-
isEntityReference
boolean isEntityReference()用于检查此事件是否为 EntityReference 的实用函数。- 返回:
-
如果事件是
EntityReference
,则返回 true,否则返回 false - 另请参阅:
-
isProcessingInstruction
boolean isProcessingInstruction()用于检查此事件是否为 ProcessingInstruction 的实用函数。- 返回:
-
如果事件是
ProcessingInstruction
,则返回 true,否则返回 false - 另请参阅:
-
isCharacters
boolean isCharacters()用于检查此事件是否为 Characters 的实用函数。- 返回:
-
如果事件是
Characters
,则返回 true,否则返回 false - 另请参阅:
-
isStartDocument
boolean isStartDocument()用于检查此事件是否为 StartDocument 的实用函数。- 返回:
-
如果事件是
StartDocument
,则返回 true,否则返回 false - 另请参阅:
-
isEndDocument
boolean isEndDocument()用于检查此事件是否为 EndDocument 的实用函数。- 返回:
-
如果事件是
EndDocument
,则返回 true,否则返回 false - 另请参阅:
-
asStartElement
StartElement asStartElement()将此事件作为开始元素事件返回,如果此事件不是开始元素,则可能导致类转换异常。- 返回:
-
一个
StartElement
事件
-
asEndElement
EndElement asEndElement()将此事件作为结束元素事件返回,如果此事件不是结束元素,则可能导致类转换异常。- 返回:
-
一个
EndElement
事件
-
asCharacters
Characters asCharacters()将此事件作为 Characters 返回,如果此事件不是 Characters,则可能导致类转换异常。- 返回:
-
一个
Characters
事件
-
getSchemaType
QName getSchemaType()此方法由实现提供,用于提供关联事件的可选类型信息。如果没有可用信息,则是可选的,将返回 null。- 返回:
- 事件的类型,如果不可用则返回 null
-
writeAsEncodedUnicode
此方法将按照 XML 1.0 规范将 XMLEvent 写入为 Unicode 字符。不应输出缩进或空格。任何用户定义的事件类型在写入到输出流时都必须调用此方法。内置事件类型必须实现此方法,但实现在将内置事件写入输出流时可能出于优化原因选择不调用这些方法。生成的输出在表达信息集方面必须是等效的。- 参数:
-
writer
- 将输出数据的写入器 - 抛出:
-
XMLStreamException
- 如果写入事件时发生致命错误
-