JavaTM Platform
Standard Ed. 6

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 とアプリケーションの通信に使用される値オブジェクトです。イベントは、構文解析の終了後、キャッシュに格納され、参照されることがあります。

導入されたバージョン:
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

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 として返します。このイベントが Characters ではない場合、結果がクラスのキャスト例外になることがあります。


getSchemaType

QName getSchemaType()
このメソッドは実装用に提供され、関連付けられたイベントに関するオプションの型情報を提供します。このメソッドはオプションであり、情報がない場合は null を返します。


writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer)
                           throws XMLStreamException
このメソッドは、XML 1.0 仕様に従って XMLEvent を Unicode 文字として書き込みます。インデントおよび空白文字は出力されません。 ユーザー定義のイベント型が出力ストリームへ書き込まれるときには、このメソッドが必ず呼び出されます。組み込み Event 型はこのメソッドを実装する必要がありますが、実装では最適化を行うために、組み込み Events を出力ストリームに書き込むときに、これらのメソッドを呼び出さないことがあります。生成される出力では、表現される infoset が同じでなければなりません。

パラメータ:
writer - データを出力するライター
例外:
XMLStreamException - イベントの書き込み時に致命的なエラーが発生したかどうか

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。