インタフェースStartDocument

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

XMLEvent, XMLStreamConstants

public interface StartDocument extends XMLEvent

文書開始イベントのインタフェースです。

導入されたバージョン:

1.6

フィールドのサマリー

インタフェースで宣言されたフィールド XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

修飾子と型	フィールド	説明
static final int	ATTRIBUTE	イベントが属性であることを示します。
static final int	CDATA	イベントがCDATAセクションであることを示します。
static final int	CHARACTERS	イベントが文字であることを示します。
static final int	COMMENT	イベントがコメントであることを示します。
static final int	DTD	イベントがDTDであることを示します。
static final int	END_DOCUMENT	イベントが文書終了であることを示します。
static final int	END_ELEMENT	イベントが要素終了であることを示します。
static final int	ENTITY_DECLARATION	エンティティ宣言を示します。
static final int	ENTITY_REFERENCE	イベントがエンティティ参照であることを示します。
static final int	NAMESPACE	イベントが名前空間宣言であることを示します。
static final int	NOTATION_DECLARATION	表記法を示します。
static final int	PROCESSING_INSTRUCTION	イベントが処理命令であることを示します。
static final int	SPACE	文字は空白文字です(「XML」2.10「White Space Handling」を参照)。
static final int	START_DOCUMENT	イベントが文書開始であることを示します。
static final int	START_ELEMENT	イベントが要素開始であることを示します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	encodingSet()	CharacterEncodingSchemeがドキュメントのエンコーディング宣言で設定されている場合はtrueを戻します
String	getCharacterEncodingScheme()	XMLデータのエンコーディング形式を返します。
String	getSystemId()	XMLデータのシステムIDを返します。
String	getVersion()	このXMLストリームのXMLのバージョンを返します。
boolean	isStandalone()	このXMLがスタンドアロンであるかどうかを返します。
boolean	standaloneSet()	スタンドアロン属性がドキュメントのエンコーディング宣言で設定されている場合にtrueを返します。

インタフェースで宣言されたメソッド XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

修飾子と型	メソッド	説明
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文字として書き込みます。

メソッドの詳細

getSystemId

String getSystemId()

XMLデータのシステムIDを返します。

戻り値:

システムID。デフォルトは""

getCharacterEncodingScheme

String getCharacterEncodingScheme()

XMLデータのエンコーディング形式を返します。

戻り値:

文字エンコーディング。デフォルトは「UTF-8」

encodingSet

boolean encodingSet()

CharacterEncodingSchemeがドキュメントのエンコーディング宣言で設定されている場合はtrueを戻します

戻り値:

CharacterEncodingSchemeが設定されている場合はtrue、そうでない場合はfalse

isStandalone

boolean isStandalone()

このXMLがスタンドアロンであるかどうかを返します。

戻り値:

XMLのスタンドアロン状態。デフォルトは「no」

standaloneSet

boolean standaloneSet()

スタンドアロン属性がドキュメントのエンコーディング宣言で設定されている場合にtrueを返します。

戻り値:

スタンドアロン属性が設定されている場合はtrue、そうでない場合はfalse

getVersion

String getVersion()

このXMLストリームのXMLのバージョンを返します。

戻り値:

XMLのバージョン。デフォルトは「1.0」