モジュール java.xml
パッケージ 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として返します。このイベントが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の場合はtrue、そうでない場合はfalse
      関連項目:
      StartElement

    • isAttribute

      boolean isAttribute()
      このイベントがAttributeかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがAttributeの場合はtrue、そうでない場合はfalse
      関連項目:
      Attribute

    • isNamespace

      boolean isNamespace()
      このイベントがNamespaceかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがNamespaceの場合はtrue、そうでない場合はfalse
      関連項目:
      Namespace

    • isEndElement

      boolean isEndElement()
      このイベントがEndElementかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがEndElementの場合はtrue、そうでない場合はfalse
      関連項目:
      EndElement

    • isEntityReference

      boolean isEntityReference()
      このイベントがEntityReferenceかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがEntityReferenceの場合はtrue、そうでない場合はfalse
      関連項目:
      EntityReference

    • isProcessingInstruction

      boolean isProcessingInstruction()
      このイベントがProcessingInstructionかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがProcessingInstructionの場合はtrue、そうでない場合はfalse
      関連項目:
      ProcessingInstruction

    • isCharacters

      boolean isCharacters()
      このイベントがCharactersかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがCharactersの場合はtrue、そうでない場合はfalse
      関連項目:
      Characters

    • isStartDocument

      boolean isStartDocument()
      このイベントがStartDocumentかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがStartDocumentの場合はtrue、そうでない場合はfalse
      関連項目:
      StartDocument

    • isEndDocument

      boolean isEndDocument()
      このイベントがEndDocumentかどうかを調べるユーティリティ機能です。
      戻り値:
      イベントがEndDocumentの場合はtrue、そうでない場合はfalse
      関連項目:
      EndDocument

    • asStartElement

      StartElement asStartElement()
      このイベントを要素開始イベントとして返します。このイベントが要素開始イベントではない場合、結果がクラスのキャスト例外になることがあります。
      戻り値:
      StartElementイベント

    • asEndElement

      EndElement asEndElement()
      このイベントを要素終了イベントとして返します。このイベントが要素終了イベントではない場合、結果がクラスのキャスト例外になることがあります。
      戻り値:
      EndElementイベント

    • asCharacters

      Characters asCharacters()
      このイベントをCharactersとして返します。このイベントがCharactersではない場合、結果がクラスのキャスト例外になることがあります。
      戻り値:
      Charactersイベント

    • getSchemaType

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

    • writeAsEncodedUnicode

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