モジュール java.xml
パッケージ javax.xml.stream

インタフェースXMLEventReader

すべてのスーパー・インタフェース:
Iterator<Object>
既知のすべての実装クラス:
EventReaderDelegate
public interface XMLEventReader
extends Iterator<Object>
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で宣言されたメソッド

    forEachRemaining, next, remove

  • メソッドの詳細

    • nextEvent

      XMLEvent nextEvent() throws XMLStreamException
      次のXMLEventを取得します。 最初のイベントはStartDocumentです。
      戻り値:
      次のXMLEvent
      例外:
      XMLStreamException - ベースとなるXMLにエラーが発生した場合。
      NoSuchElementException - 反復にはそれ以上の要素はありません。
      関連項目:
      XMLEvent

    • hasNext

      boolean hasNext()
      それ以上イベントが存在するかどうかを調べます。 イベントがまだある場合はtrue、そうでない場合はfalseを返します。
      定義:
      インタフェースIterator<Object>内のhasNext
      戻り値:
      イベント・リーダーにイベントがまだある場合はtrue、そうでない場合はfalse

    • peek

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

    • getElementText

      String getElementText() throws XMLStreamException
      テキストのみの要素のコンテンツを読み取ります。 前提条件: 現在のイベントがSTART_ELEMENTである。 事後条件: 現在のイベントが対応するEND_ELEMENTである。
      戻り値:
      要素のテキスト
      例外:
      XMLStreamException - 現在のイベントがSTART_ELEMENTでない場合、またはテキスト以外の要素が見つかった場合

    • nextTag

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

    • getProperty

      Object getProperty​(String name) throws IllegalArgumentException
      ベースとなる実装から機能またはプロパティの値を取得します。
      パラメータ:
      name - プロパティの名前
      戻り値:
      プロパティの値
      例外:
      IllegalArgumentException - プロパティがサポートされていない場合

    • close

      void close() throws XMLStreamException
      このリーダーに関連付けられているリソースをすべて解放します。 このメソッドはベースとなる入力ソースを閉じません。
      例外:
      XMLStreamException - 関連付けられているリソースの解放でエラーが発生した場合