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

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

XMLStreamConstants

既知の実装クラスの一覧:

StreamReaderDelegate

public interface XMLStreamReader
extends XMLStreamConstants

XMLStreamReader インタフェースを使用すると、XML の順方向の読み取り専用アクセスを行うことができます。これは、XML データの最下位レベルでのもっとも効率的な読み取り方法となるように設計されています。 　

XMLStreamReader は next() と hasNext() を使用して XML を繰り返し処理していくように設計されています。データには、getEventType()、getNamespaceURI()、getLocalName()、getText() などのメソッドを使用してアクセス可能です。 　

next() メソッドを使用すると、リーダーは次の解析イベントを読み取ります。next() メソッドは、読み取ったイベントの型を識別する整数値を返します。 　

イベント型は、getEventType() を使用して判別できます。 　

イベントの解析は、XML 宣言、DTD、開始タグ、文字データ、空白文字、終了タグ、コメント、または処理命令として定義されます。属性イベントまたは名前空間イベントが、クエリー処理の結果としてドキュメントのルートレベルで見つかる場合もあります。 　

XML 1.0 準拠の XML プロセッサは、宣言済みの解析対象外エンティティーの識別子、表記法宣言、およびそれらに関連付けられた識別子をアプリケーションに渡します。これらの情報は、このインタフェースのプロパティー API を通じて提供されます。javax.xml.stream.notations と javax.xml.stream.entities の 2 つのプロパティーによって、これらの情報にアクセスできます。現在のイベントが DTD であれば、List l = (List) getProperty("javax.xml.stream.notations"); の呼び出しによって表記法のリストが返されます。List l = (List) getProperty("javax.xml.stream.entities"); の呼び出しによって、エンティティー宣言のリストが返されます。これらのプロパティーには、DTD イベントの間のみアクセスできます。また、情報が無効な場合は null が返されるように定義されています。 　

次の表に、どのメソッドがどのような状態で有効かについて示します。無効な状態で呼び出されたメソッドは java.lang.IllegalStateException をスローします。

状態ごとの有効なメソッド
イベント型	有効なメソッド
すべての状態	getProperty()、hasNext()、require()、close()、getNamespaceURI()、isStartElement()、isEndElement()、isCharacters()、isWhiteSpace()、getNamespaceContext()、getEventType(),getLocation()、hasText()、hasName()
START_ELEMENT	next()、getName()、getLocalName()、hasName()、getPrefix()、getAttributeXXX()、isAttributeSpecified()、getNamespaceXXX()、getElementText()、nextTag()
ATTRIBUTE	next()、nextTag() getAttributeXXX()、isAttributeSpecified()
NAMESPACE	next()、nextTag()、getNamespaceXXX()
END_ELEMENT	next()、getName()、getLocalName()、hasName()、getPrefix()、getNamespaceXXX()、nextTag()
CHARACTERS	next()、getTextXXX()、nextTag()
CDATA	next()、getTextXXX()、nextTag()
COMMENT	next()、getTextXXX()、nextTag()
SPACE	next()、getTextXXX()、nextTag()
START_DOCUMENT	next()、getEncoding()、getVersion()、isStandalone()、standaloneSet()、getCharacterEncodingScheme()、nextTag()
END_DOCUMENT	close()
PROCESSING_INSTRUCTION	next()、getPITarget()、getPIData()、nextTag()
ENTITY_REFERENCE	next()、getLocalName()、getText()、nextTag()
DTD	next()、getText()、nextTag()

導入されたバージョン:

1.6

関連項目:

XMLEvent, XMLInputFactory, XMLStreamWriter

フィールドの概要

インタフェース 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

メソッドの概要

void	close() このリーダーに関連付けられたリソースをすべて解放します。
int	getAttributeCount() この START_ELEMENT 上の属性の数を返します。
String	getAttributeLocalName(int index) 指定されたインデックスにある属性の localName を返します。
QName	getAttributeName(int index) 指定されたインデックスにある属性の qname を返します。
String	getAttributeNamespace(int index) 指定されたインデックスにある属性の名前空間を返します。
String	getAttributePrefix(int index) 指定されたインデックスにある属性の接頭辞を返します。
String	getAttributeType(int index) 指定されたインデックスにある属性の XML 型を返します。
String	getAttributeValue(int index) インデックスにある属性の値を返します。
String	getAttributeValue(String namespaceURI, String localName) 名前空間と localName を持つ属性の正規化された属性値を返します。
String	getCharacterEncodingScheme() XML 宣言で宣言された文字エンコーディングを返します。
String	getElementText() テキストのみの要素のコンテンツを読み取ります。
String	getEncoding() 入力エンコーディングが既知の場合は、その入力エンコーディングを返します。
int	getEventType() カーソルがポイントしているイベントの型を示す整数型コードを返します。
String	getLocalName() 現在のイベントのローカル名を返します。
Location	getLocation() プロセッサの現在の位置を返します。
QName	getName() 現在の START_ELEMENT または END_ELEMENT イベントの QName を返します。
NamespaceContext	getNamespaceContext() 現在の位置の読み取り専用の名前空間コンテキストを返します。
int	getNamespaceCount() この START_ELEMENT または END_ELEMENT で宣言された名前空間の数を返します。
String	getNamespacePrefix(int index) 指定されたインデックスで宣言された名前空間の接頭辞を返します。
String	getNamespaceURI() 現在のイベントが START_ELEMENT または END_ELEMENT である場合、このメソッドは接頭辞の URI またはデフォルトの名前空間を返します。
String	getNamespaceURI(int index) 指定されたインデックスで宣言された名前空間の URI を返します。
String	getNamespaceURI(String prefix) 指定された接頭辞の URI を返します。
String	getPIData() 処理命令のデータセクションを取得します。
String	getPITarget() 処理命令のターゲットを取得します。
String	getPrefix() 現在のイベントの接頭辞を返します。
Object	getProperty(String name) 基本となる実装から機能またはプロパティーの値を取得します。
String	getText() 構文解析イベントの現在の値を文字列として返します。
char[]	getTextCharacters() このイベントからの文字を含む配列を返します。
int	getTextCharacters(int sourceStart, char[] target, int targetStart, int length) CHARACTERS、SPACE、または CDATA イベントに関連付けられたテキストを取得します。
int	getTextLength() このテキストイベントに対するテキスト文字配列内の文字シーケンスの長さを返します。
int	getTextStart() このテキストイベントの最初の文字が保存されているテキスト文字配列へのオフセットを返します。
String	getVersion() XML 宣言で宣言された XML バージョンを取得します。
boolean	hasName() 現在のイベントが名前 (START_ELEMENT または END_ELEMENT) を持つ場合 true、そうでない場合 false を返します。
boolean	hasNext() 構文解析イベントがまだある場合は true、そうでない場合は false を返します。
boolean	hasText() 現在のイベントにテキストが含まれる場合 true、そうでない場合 false を返します。
boolean	isAttributeSpecified(int index) この属性がデフォルトで作成されたかどうかを示す boolean 値を返します。
boolean	isCharacters() カーソルが文字データイベントをポイントしている場合は true を返します。
boolean	isEndElement() カーソルが終了タグをポイントしている場合は true、そうでない場合は false を返します。
boolean	isStandalone() XML 宣言からスタンドアロン宣言を取得します。
boolean	isStartElement() カーソルが開始タグをポイントしている場合は true、そうでない場合は false を返します。
boolean	isWhiteSpace() カーソルが空白文字だけで構成される文字データイベントをポイントしている場合は true を返します。
int	next() 次の構文解析イベントを取得します。
int	nextTag() START_ELEMENT または END_ELEMENT に達するまで、すべての空白文字 (isWhiteSpace() が true を返す)、COMMENT、または PROCESSING_INSTRUCTION をスキップします。
void	require(int type, String namespaceURI, String localName) 現在のイベントが指定の型かどうか、名前空間と名前が現在のイベントの現在の名前空間と名前に一致するかどうかをテストします。
boolean	standaloneSet() ドキュメントでスタンドアロンが設定されていたかどうかを確認します。

メソッドの詳細

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException

基本となる実装から機能またはプロパティーの値を取得します。

パラメータ:

name - プロパティーの名前 (null 以外)

戻り値:

プロパティーの値

例外:

IllegalArgumentException - name が null の場合

next

int next()
         throws XMLStreamException

次の構文解析イベントを取得します。プロセッサは、連続する文字データをすべて単一のチャンクとして、またはいくつかのチャンクに分割して返します。javax.xml.stream.isCoalescing プロパティーが true に設定されている場合は、要素コンテンツを合体し、連続する要素コンテンツまたは CDATA セクションに対して、CHARACTERS イベントが 1 つだけ返されるようにしてください。 デフォルトでは、エンティティー参照は展開され、アプリケーションに透過的に報告される必要があります。エンティティー参照を展開できない場合は、例外がスローされます。要素コンテンツが空 (つまり "") の場合、CHARACTERS イベントは報告されません。 　

次の XML について考えます。
<foo><!--description-->content text<![CDATA[<greeting>Hello</greeting>]]>other content</foo>
foo に対する next() 呼び出しの動作は以下のとおりです。
1- コメント (COMMENT)
2- 文字セクション (CHARACTERS)
3- CDATA セクション (もう 1 つの CHARACTERS)
4- 次の文字セクション (もう 1 つの CHARACTERS)
5- END_ELEMENT
　

注: 空の要素 (<tag/> など) は 2 つの別個のイベントである START_ELEMENT と END_ELEMENT として報告されます。これにより、空の要素の解析が <tag></tag> と等しく保たれます。 hasNext() が false を返すと、このメソッドは IllegalStateException をスローします。

戻り値:

現在の構文解析イベントに対応する整数型コード

例外:

NoSuchElementException - hasNext() が false を返したときに呼び出された場合

XMLStreamException - 基本となる XML ソースの処理にエラーが発生した場合

関連項目:

XMLEvent

require

void require(int type,
             String namespaceURI,
             String localName)
             throws XMLStreamException

現在のイベントが指定の型かどうか、名前空間と名前が現在のイベントの現在の名前空間と名前に一致するかどうかをテストします。namespaceURI が null の場合、名前空間が一致するかどうかは確認されません。また、localName が null の場合、名前が一致するかどうかは確認されません。

パラメータ:

type - イベントの型

namespaceURI - イベントの URI (null の場合もある)

localName - イベントの localName (null の場合もある)

例外:

XMLStreamException - 要求された値が一致しなかった場合

getElementText

String getElementText()
                      throws XMLStreamException

テキストのみの要素のコンテンツを読み取ります。テキストのみの要素でない場合は、例外がスローされます。javax.xml.stream.isCoalescing の値に関係なく、このメソッドは常に合体したコンテンツを返します。
前提条件は、現在のイベントが START_ELEMENT であることです。
事後条件は、現在のイベントが対応する END_ELEMENT であることです。
メソッドは次の処理を実行します (実装では最適化することもできますが、同等の処理を実行する必要があります)。

 if(getEventType() != XMLStreamConstants.START_ELEMENT) {
 throw new XMLStreamException(
 "parser must be on START_ELEMENT to read next text", getLocation());
 }
 int eventType = next();
 StringBuffer content = new StringBuffer();
 while(eventType != XMLStreamConstants.END_ELEMENT ) {
 if(eventType == XMLStreamConstants.CHARACTERS
 || eventType == XMLStreamConstants.CDATA
 || eventType == XMLStreamConstants.SPACE
 || eventType == XMLStreamConstants.ENTITY_REFERENCE) {
 buf.append(getText());
 } else if(eventType == XMLStreamConstants.PROCESSING_INSTRUCTION
 || eventType == XMLStreamConstants.COMMENT) {
 // skipping
 } else if(eventType == XMLStreamConstants.END_DOCUMENT) {
 throw new XMLStreamException(
 "unexpected end of document when reading element text content", this);
 } else if(eventType == XMLStreamConstants.START_ELEMENT) {
 throw new XMLStreamException(
 "element text content may not contain START_ELEMENT", getLocation());
 } else {
 throw new XMLStreamException(
 "Unexpected event type "+eventType, getLocation());
 }
 eventType = next();
 }
 return buf.toString();
 

戻り値:

テキストのみの要素のコンテンツ

例外:

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

nextTag

int nextTag()
            throws XMLStreamException

START_ELEMENT または END_ELEMENT に達するまで、すべての空白文字 (isWhiteSpace() が true を返す)、COMMENT、または PROCESSING_INSTRUCTION をスキップします。空白文字、COMMENT、PROCESSING_INSTRUCTION、START_ELEMENT、END_ELEMENT 以外が見つかると、例外がスローされます。空白文字で区切られた要素のみのコンテンツを処理するときには、このメソッドを使用するようにします。
前提条件はありません。
事後条件は、現在のイベントが START_ELEMENT または END_ELEMENT であり、カーソルがいずれかの空白文字イベントの上を動いた場合です。
基本的に、次の処理を実行します (実装では最適化することもできますが、同等の処理を実行する必要があります)。

 int eventType = next();
 while((eventType == XMLStreamConstants.CHARACTERS && isWhiteSpace()) // skip whitespace
 || (eventType == XMLStreamConstants.CDATA && isWhiteSpace()) 
 // skip whitespace
 || eventType == XMLStreamConstants.SPACE
 || eventType == XMLStreamConstants.PROCESSING_INSTRUCTION
 || eventType == XMLStreamConstants.COMMENT
 ) {
 eventType = next();
 }
 if (eventType != XMLStreamConstants.START_ELEMENT && eventType != XMLStreamConstants.END_ELEMENT) {
 throw new String XMLStreamException("expected start or end tag", getLocation());
 }
 return eventType;
 

戻り値:

読み取った要素のイベント型 (START_ELEMENT または END_ELEMENT)

例外:

XMLStreamException - 現在のイベントが空白文字、PROCESSING_INSTRUCTION、 START_ELEMENT、または END_ELEMENT でない場合

NoSuchElementException - hasNext() が false を返したときに呼び出された場合

hasNext

boolean hasNext()
                throws XMLStreamException

構文解析イベントがまだある場合は true、そうでない場合は false を返します。このメソッドは、XMLStreamReader の現在の状態が END_DOCUMENT の場合は false を返します。

戻り値:

イベントがまだある場合は true、そうでない場合は false

例外:

XMLStreamException - 次の状態の検出時に致命的なエラーが発生した場合

close

void close()
           throws XMLStreamException

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

例外:

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

getNamespaceURI

String getNamespaceURI(String prefix)

指定された接頭辞の URI を返します。返される URI はプロセッサの現在の状態によって異なります。 　

注: 接頭辞「xml」は、Namespaces in XML 勧告で定義されているように「http://www.w3.org/XML/1998/namespace」にバインドされます。

　

注: 接頭辞「xmlns」は名前空間 http://www.w3.org/2000/xmlns/ に解決される必要があります。

パラメータ:

prefix - 検索する接頭辞 (null 以外)

戻り値:

指定された接頭辞にバインドされた URI。バインドされていない場合は null

例外:

IllegalArgumentException - 接頭辞が null の場合

isStartElement

boolean isStartElement()

カーソルが開始タグをポイントしている場合は true、そうでない場合は false を返します。

戻り値:

カーソルが開始タグをポイントしている場合は true、そうでない場合は false

isEndElement

boolean isEndElement()

カーソルが終了タグをポイントしている場合は true、そうでない場合は false を返します。

戻り値:

カーソルが終了タグをポイントしている場合は true、そうでない場合は false

isCharacters

boolean isCharacters()

カーソルが文字データイベントをポイントしている場合は true を返します。

戻り値:

カーソルが文字データをポイントしている場合は true、そうでない場合は false

isWhiteSpace

boolean isWhiteSpace()

カーソルが空白文字だけで構成される文字データイベントをポイントしている場合は true を返します。

戻り値:

カーソルがすべての空白文字をポイントしている場合は true、そうでない場合は false

getAttributeValue

String getAttributeValue(String namespaceURI,
                         String localName)

名前空間と localName を持つ属性の正規化された属性値を返します。namespaceURI が null の場合、名前空間が一致するかどうかは確認されません。

パラメータ:

namespaceURI - 属性の名前空間

localName - 属性のローカル名 (null 以外)

戻り値:

属性の値。見つからない場合は null

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeCount

int getAttributeCount()

この START_ELEMENT 上の属性の数を返します。このメソッドは START_ELEMENT または ATTRIBUTE のみで有効です。この数には、名前空間の定義は含まれません。属性インデックスはゼロから始まります。

戻り値:

属性の数

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeName

QName getAttributeName(int index)

指定されたインデックスにある属性の qname を返します。

パラメータ:

index - 属性の位置

戻り値:

属性の QName

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeNamespace

String getAttributeNamespace(int index)

指定されたインデックスにある属性の名前空間を返します。

パラメータ:

index - 属性の位置

戻り値:

名前空間 URI (null の場合もある)

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeLocalName

String getAttributeLocalName(int index)

指定されたインデックスにある属性の localName を返します。

パラメータ:

index - 属性の位置

戻り値:

属性の localName

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributePrefix

String getAttributePrefix(int index)

指定されたインデックスにある属性の接頭辞を返します。

パラメータ:

index - 属性の位置

戻り値:

属性の接頭辞

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeType

String getAttributeType(int index)

指定されたインデックスにある属性の XML 型を返します。

パラメータ:

index - 属性の位置

戻り値:

属性の XML 型

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getAttributeValue

String getAttributeValue(int index)

インデックスにある属性の値を返します。

パラメータ:

index - 属性の位置

戻り値:

属性値

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

isAttributeSpecified

boolean isAttributeSpecified(int index)

この属性がデフォルトで作成されたかどうかを示す boolean 値を返します。

パラメータ:

index - 属性の位置

戻り値:

デフォルトの属性である場合は true

例外:

IllegalStateException - START_ELEMENT または ATTRIBUTE でない場合

getNamespaceCount

int getNamespaceCount()

この START_ELEMENT または END_ELEMENT で宣言された名前空間の数を返します。このメソッドは START_ELEMENT、END_ELEMENT、または NAMESPACE のみで有効です。END_ELEMENT では、範囲外になろうとしている名前空間の数になります。これは、要素終了イベントの SAX コールバックによって報告される情報と同等です。

戻り値:

この要素上の名前空間宣言の数

例外:

IllegalStateException - START_ELEMENT、END_ELEMENT、または NAMESPACE でない場合

getNamespacePrefix

String getNamespacePrefix(int index)

指定されたインデックスで宣言された名前空間の接頭辞を返します。デフォルトの名前空間宣言の場合は null を返します。

パラメータ:

index - 名前空間宣言の位置

戻り値:

名前空間の接頭辞

例外:

IllegalStateException - START_ELEMENT、END_ELEMENT、または NAMESPACE でない場合

getNamespaceURI

String getNamespaceURI(int index)

指定されたインデックスで宣言された名前空間の URI を返します。

パラメータ:

index - 名前空間宣言の位置

戻り値:

名前空間 URI

例外:

IllegalStateException - START_ELEMENT、END_ELEMENT、または NAMESPACE でない場合

getNamespaceContext

NamespaceContext getNamespaceContext()

現在の位置の読み取り専用の名前空間コンテキストを返します。コンテキストは一時的なもので、next() の呼び出しによってリーダーの状態が変更されるまで有効です。

戻り値:

名前空間コンテキスト

getEventType

int getEventType()

カーソルがポイントしているイベントの型を示す整数型コードを返します。

getText

String getText()

構文解析イベントの現在の値を文字列として返します。CHARACTERS イベントの文字列値、COMMENT の値、ENTITY_REFERENCE の置換値、CDATA セクションの文字列値、SPACE イベントの文字列値、DTD の内部サブセットの文字列値を返します。ENTITY_REFERENCE が解決されている場合、すべての文字データが CHARACTERS イベントとして報告されます。

戻り値:

現在のテキストまたは null

例外:

IllegalStateException - この状態が 有効なテキスト状態でない場合

getTextCharacters

char[] getTextCharacters()

このイベントからの文字を含む配列を返します。この配列を読み取り専用で一時的なものとして処理するようにします。つまり、この配列にテキスト文字が含まれるのは、XMLStreamReader が次のイベントに移動するまでの間です。それ以上の期間テキストを文字配列に保持したり、配列の内容を変更したりすると、このインタフェースの規約違反になります。

戻り値:

現在のテキストまたは空の配列

例外:

IllegalStateException - この状態が 有効なテキスト状態でない場合

getTextCharacters

int getTextCharacters(int sourceStart,
                      char[] target,
                      int targetStart,
                      int length)
                      throws XMLStreamException

CHARACTERS、SPACE、または CDATA イベントに関連付けられたテキストを取得します。sourceStart で始まるテキストが、target の targetStart で始まる位置にコピーされます。最大で length の数の文字がコピーされます。実際にコピーされた文字数が返されます。 sourceStart 引数は 0 以上で、イベントに関連付けられた文字数以下であることが必要です。通常、sourceStart が 0 の位置で始まるテキストが要求されます。実際にコピーされた文字数が length よりも少なかった場合、それ以上のテキストは存在しません。そうでない場合、すべてのテキストが取得されるまで後続の呼び出しが必要になります。次に例を示します。 int length = 1024; char[] myBuffer = new char[ length ]; for ( int sourceStart = 0 ; ; sourceStart += length ) { int nCopied = stream.getTextCharacters( sourceStart, myBuffer, 0, length ); if (nCopied < length) break; }基本となるソースで何らかの XML エラーが発生すると、XMLStreamException がスローされます。targetStart 引数は 0 以上で、target の長さよりも小さい必要があり、length は 0 よりも大きく、targetStart と length の合計は target の長さ以下であることが必要です。

パラメータ:

sourceStart - コピー対象ソース配列内の最初の文字のインデックス

target - 転送先配列

targetStart - ターゲットの配列内での開始オフセット

length - コピーする文字数

戻り値:

実際にコピーした文字数

例外:

XMLStreamException - 基本となる XML ソースが整形式でない場合

IndexOutOfBoundsException - targetStart が 0 よりも小さいか、ターゲットの長さよりも大きい場合

IndexOutOfBoundsException - length が 0 よりも小さいか、targetStart と length の合計がターゲットの長さよりも大きい場合

UnsupportedOperationException - このメソッドがサポートされていない場合

NullPointerException - target が null の場合

getTextStart

int getTextStart()

このテキストイベントの最初の文字が保存されているテキスト文字配列へのオフセットを返します。

例外:

IllegalStateException - この状態が 有効なテキスト状態でない場合

getTextLength

int getTextLength()

このテキストイベントに対するテキスト文字配列内の文字シーケンスの長さを返します。

例外:

IllegalStateException - この状態が 有効なテキスト状態でない場合

getEncoding

String getEncoding()

入力エンコーディングが既知の場合は、その入力エンコーディングを返します。未知の場合は null を返します。

戻り値:

このインスタンスのエンコーディングまたは null

hasText

boolean hasText()

現在のイベントにテキストが含まれる場合 true、そうでない場合 false を返します。CHARACTERS、DTD、ENTITY_REFERENCE、COMMENT、SPACE の各イベントにはテキストが含まれます。

getLocation

Location getLocation()

プロセッサの現在の位置を返します。Location がわからない場合、プロセッサは Location の実装を返します。これは、位置について -1 を返し、publicId と systemId について null を返します。位置情報は、next() が呼び出されるまで有効です。

getName

QName getName()

現在の START_ELEMENT または END_ELEMENT イベントの QName を返します。

戻り値:

現在の START_ELEMENT または END_ELEMENT イベントの QName

例外:

IllegalStateException - START_ELEMENT または END_ELEMENT でない場合

getLocalName

String getLocalName()

現在のイベントのローカル名を返します。START_ELEMENT または END_ELEMENT については、現在の要素のローカル名を返します。ENTITY_REFERENCE については、エンティティー名を返します。現在のイベントは、START_ELEMENT、END_ELEMENT、ENTITY_REFERENCE のいずれかでなければなりません。

戻り値:

localName

例外:

IllegalStateException - START_ELEMENT、 END_ELEMENT、または ENTITY_REFERENCE でない場合

hasName

boolean hasName()

現在のイベントが名前 (START_ELEMENT または END_ELEMENT) を持つ場合 true、そうでない場合 false を返します。

getNamespaceURI

String getNamespaceURI()

現在のイベントが START_ELEMENT または END_ELEMENT である場合、このメソッドは接頭辞の URI またはデフォルトの名前空間を返します。イベントが接頭辞を持たない場合、null を返します。

戻り値:

この要素の接頭辞にバインドされた URI、デフォルトの名前空間、または null

getPrefix

String getPrefix()

現在のイベントの接頭辞を返します。イベントが接頭辞を持たない場合は null を返します。

戻り値:

接頭辞または null

getVersion

String getVersion()

XML 宣言で宣言された XML バージョンを取得します。宣言されていない場合は null を返します。

戻り値:

XML バージョンまたは null

isStandalone

boolean isStandalone()

XML 宣言からスタンドアロン宣言を取得します。

戻り値:

スタンドアロンである場合は true、そうでない場合は false

standaloneSet

boolean standaloneSet()

ドキュメントでスタンドアロンが設定されていたかどうかを確認します。

戻り値:

ドキュメントでスタンドアロンが設定されていた場合は true、そうでない場合は false

getCharacterEncodingScheme

String getCharacterEncodingScheme()

XML 宣言で宣言された文字エンコーディングを返します。宣言されていない場合は null を返します。

戻り値:

ドキュメントで宣言されたエンコーディングまたは null

getPITarget

String getPITarget()

処理命令のターゲットを取得します。

戻り値:

ターゲットまたは null

getPIData

String getPIData()

処理命令のデータセクションを取得します。

戻り値:

データまたは null