JavaTM Platform
Standard Ed. 6

javax.xml.stream
インタフェース XMLEventReader

すべてのスーパーインタフェース:
Iterator
既知の実装クラスの一覧:
EventReaderDelegate

public interface XMLEventReader
extends Iterator

XMLEvent を構文解析するための最上位のインタフェースです。これを使用すると、次に続くイベントを調べ、プロパティーインタフェースを通じて構成情報を返すことができます。

導入されたバージョン:
1.6
関連項目:
XMLInputFactory, XMLEventWriter

メソッドの概要
 void close()
          このリーダーに関連付けられたリソースをすべて解放します。
 String getElementText()
          テキストのみの要素のコンテンツを読み取ります。
 Object getProperty(String name)
          基本となる実装から機能またはプロパティーの値を取得します。
 boolean hasNext()
          それ以上イベントが存在するかどうかを調べます。
 XMLEvent nextEvent()
          次の XMLEvent を取得します。
 XMLEvent nextTag()
          START_ELEMENT または END_ELEMENT に達するまで、意味のない空白イベントをスキップします。
 XMLEvent peek()
          次の XMLEvent を調べます。
 
インタフェース java.util.Iterator から継承されたメソッド
next, remove
 

メソッドの詳細

nextEvent

XMLEvent nextEvent()
                   throws XMLStreamException
次の XMLEvent を取得します。

例外:
XMLStreamException - 基本となる XML にエラーが発生した場合
NoSuchElementException - 繰り返し処理でそれ以上要素がない場合
関連項目:
XMLEvent

hasNext

boolean hasNext()
それ以上イベントが存在するかどうかを調べます。イベントがまだある場合は true、そうでない場合は false を返します。

定義:
インタフェース Iterator 内の hasNext
戻り値:
イベントリーダーにイベントがまだある場合は true、そうでない場合は false

peek

XMLEvent peek()
              throws XMLStreamException
次の XMLEvent を調べます。ただし、ストリームから読み取ることはしません。ストリームが EOF になった場合、または次の XMLEvent がない場合は null を返します。peek() の呼び出しは、次の next() の戻りと同じになります。

例外:
XMLStreamException
関連項目:
XMLEvent

getElementText

String getElementText()
                      throws XMLStreamException
テキストのみの要素のコンテンツを読み取ります。前提条件は、現在のイベントが START_ELEMENT であることです。事後条件は、現在のイベントが対応する END_ELEMENT であることです。

例外:
XMLStreamException - 現在のイベントが START_ELEMENT でない場合、またはテキスト以外の要素が見つかった場合

nextTag

XMLEvent nextTag()
                 throws XMLStreamException
START_ELEMENT または END_ELEMENT に達するまで、意味のない空白イベントをスキップします。空白文字以外に達した場合は、例外がスローされます。このメソッドは要素のみのコンテンツを処理するときに使用するようにします。これは、DTD が見つからない場合または解釈されない場合は、無視できる空白文字をパーサーが認識できないためです。

例外:
XMLStreamException - 空白文字以外に達した場合

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException
基本となる実装から機能またはプロパティーの値を取得します。

パラメータ:
name - プロパティーの名前
戻り値:
プロパティーの値
例外:
IllegalArgumentException - プロパティーがサポートされていない場合

close

void close()
           throws XMLStreamException
このリーダーに関連付けられたリソースをすべて解放します。このメソッドは基本となる入力ソースを閉じません。

例外:
XMLStreamException - 関連付けられたリソースの解放でエラーが発生した場合

JavaTM Platform
Standard Ed. 6

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

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