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 - 如果在寫入事件時發生嚴重錯誤