|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectjavax.xml.stream.util.StreamReaderDelegate
public class StreamReaderDelegate
これは、XMLStreamReader フィルタを派生させる基底クラスです。 このクラスは、XMLStreamReader とアプリケーションの XMLStreamReader の中間に置かれます。デフォルトでは、各メソッドは何もしませんが、親インタフェース上の対応するメソッドを呼び出します。
XMLStreamReader,
EventReaderDelegate| フィールドの概要 |
|---|
| インタフェース 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 |
| コンストラクタの概要 | |
|---|---|
StreamReaderDelegate()
親を持たない空のフィルタを構築します。 |
|
StreamReaderDelegate(XMLStreamReader reader)
指定された親を持つフィルタを構築します。 |
|
| メソッドの概要 | |
|---|---|
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 を返します。 |
XMLStreamReader |
getParent()
このインスタンスの親を取得します。 |
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)
現在のイベントが指定の型かどうか、名前空間と名前が現在のイベントの現在の名前空間と名前に一致するかどうかをテストします。 |
void |
setParent(XMLStreamReader reader)
このインスタンスの親を設定します。 |
boolean |
standaloneSet()
ドキュメントでスタンドアロンが設定されていたかどうかを確認します。 |
| クラス java.lang.Object から継承されたメソッド |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| コンストラクタの詳細 |
|---|
public StreamReaderDelegate()
public StreamReaderDelegate(XMLStreamReader reader)
reader - 親| メソッドの詳細 |
|---|
public void setParent(XMLStreamReader reader)
reader - 新しい親public XMLStreamReader getParent()
public int next()
throws XMLStreamException
XMLStreamReader の記述:次の 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 をスローします。
XMLStreamReader 内の nextXMLStreamException - 基本となる XML ソースの処理にエラーが発生した場合XMLEvent
public int nextTag()
throws XMLStreamException
XMLStreamReader の記述:
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;
XMLStreamReader 内の nextTagXMLStreamException - 現在のイベントが空白文字、PROCESSING_INSTRUCTION、START_ELEMENT、または END_ELEMENT でない場合
public String getElementText()
throws XMLStreamException
XMLStreamReader の記述:
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();
XMLStreamReader 内の getElementTextXMLStreamException - 現在のイベントが START_ELEMENT でない場合、またはテキスト以外の要素が見つかった場合
public void require(int type,
String namespaceURI,
String localName)
throws XMLStreamException
XMLStreamReader の記述:
XMLStreamReader 内の requiretype - イベントの型namespaceURI - イベントの URI (null の場合もある)localName - イベントの localName (null の場合もある)
XMLStreamException - 要求された値が一致しなかった場合
public boolean hasNext()
throws XMLStreamException
XMLStreamReader の記述:
XMLStreamReader 内の hasNextXMLStreamException - 次の状態の検出時に致命的なエラーが発生した場合
public void close()
throws XMLStreamException
XMLStreamReader の記述:
XMLStreamReader 内の closeXMLStreamException - 関連付けられたリソースの解放でエラーが発生した場合public String getNamespaceURI(String prefix)
XMLStreamReader の記述:注: 接頭辞「xml」は、Namespaces in XML 勧告で定義されているように「http://www.w3.org/XML/1998/namespace」にバインドされます。
注: 接頭辞「xmlns」は名前空間 http://www.w3.org/2000/xmlns/ に解決される必要があります。
XMLStreamReader 内の getNamespaceURIprefix - 検索する接頭辞 (null 以外)
public NamespaceContext getNamespaceContext()
XMLStreamReader の記述:
XMLStreamReader 内の getNamespaceContextpublic boolean isStartElement()
XMLStreamReader の記述:
XMLStreamReader 内の isStartElementpublic boolean isEndElement()
XMLStreamReader の記述:
XMLStreamReader 内の isEndElementpublic boolean isCharacters()
XMLStreamReader の記述:
XMLStreamReader 内の isCharacterspublic boolean isWhiteSpace()
XMLStreamReader の記述:
XMLStreamReader 内の isWhiteSpace
public String getAttributeValue(String namespaceUri,
String localName)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeValuenamespaceUri - 属性の名前空間localName - 属性のローカル名 (null 以外)
public int getAttributeCount()
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeCountpublic QName getAttributeName(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeNameindex - 属性の位置
public String getAttributePrefix(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributePrefixindex - 属性の位置
public String getAttributeNamespace(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeNamespaceindex - 属性の位置
public String getAttributeLocalName(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeLocalNameindex - 属性の位置
public String getAttributeType(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeTypeindex - 属性の位置
public String getAttributeValue(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getAttributeValueindex - 属性の位置
public boolean isAttributeSpecified(int index)
XMLStreamReader の記述:
XMLStreamReader 内の isAttributeSpecifiedindex - 属性の位置
public int getNamespaceCount()
XMLStreamReader の記述:
XMLStreamReader 内の getNamespaceCountpublic String getNamespacePrefix(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getNamespacePrefixindex - 名前空間宣言の位置
public String getNamespaceURI(int index)
XMLStreamReader の記述:
XMLStreamReader 内の getNamespaceURIindex - 名前空間宣言の位置
public int getEventType()
XMLStreamReader の記述:
XMLStreamReader 内の getEventTypepublic String getText()
XMLStreamReader の記述:
XMLStreamReader 内の getText
public int getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int length)
throws XMLStreamException
XMLStreamReader の記述: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 の長さ以下であることが必要です。
XMLStreamReader 内の getTextCharacterssourceStart - コピー対象ソース配列内の最初の文字のインデックスtarget - 転送先配列targetStart - ターゲットの配列内での開始オフセットlength - コピーする文字数
XMLStreamException - 基本となる XML ソースが整形式でない場合public char[] getTextCharacters()
XMLStreamReader の記述:
XMLStreamReader 内の getTextCharacterspublic int getTextStart()
XMLStreamReader の記述:
XMLStreamReader 内の getTextStartpublic int getTextLength()
XMLStreamReader の記述:
XMLStreamReader 内の getTextLengthpublic String getEncoding()
XMLStreamReader の記述:
XMLStreamReader 内の getEncodingpublic boolean hasText()
XMLStreamReader の記述:
XMLStreamReader 内の hasTextpublic Location getLocation()
XMLStreamReader の記述:
XMLStreamReader 内の getLocationpublic QName getName()
XMLStreamReader の記述:
XMLStreamReader 内の getNamepublic String getLocalName()
XMLStreamReader の記述:
XMLStreamReader 内の getLocalNamepublic boolean hasName()
XMLStreamReader の記述:
XMLStreamReader 内の hasNamepublic String getNamespaceURI()
XMLStreamReader の記述:
XMLStreamReader 内の getNamespaceURIpublic String getPrefix()
XMLStreamReader の記述:
XMLStreamReader 内の getPrefixpublic String getVersion()
XMLStreamReader の記述:
XMLStreamReader 内の getVersionpublic boolean isStandalone()
XMLStreamReader の記述:
XMLStreamReader 内の isStandalonepublic boolean standaloneSet()
XMLStreamReader の記述:
XMLStreamReader 内の standaloneSetpublic String getCharacterEncodingScheme()
XMLStreamReader の記述:
XMLStreamReader 内の getCharacterEncodingSchemepublic String getPITarget()
XMLStreamReader の記述:
XMLStreamReader 内の getPITargetpublic String getPIData()
XMLStreamReader の記述:
XMLStreamReader 内の getPIDatapublic Object getProperty(String name)
XMLStreamReader の記述:
XMLStreamReader 内の getPropertyname - プロパティーの名前 (null 以外)
|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。