XMLEvent (Java Platform SE 8)

すべてのスーパー・インタフェース:

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

バージョン:

1.0

関連項目:

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
  - 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 - イベントの書込み時に致命的なエラーが発生したかどうか

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

インタフェースXMLEvent

フィールドのサマリー

インタフェース javax.xml.stream.XMLStreamConstantsから継承されたフィールド

メソッドのサマリー

メソッドの詳細

getEventType

getLocation

isStartElement

isAttribute

isNamespace

isEndElement

isEntityReference

isProcessingInstruction

isCharacters

isStartDocument

isEndDocument

asStartElement

asEndElement

asCharacters

getSchemaType

writeAsEncodedUnicode