この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

XmlStreamReader クラス

XmlStreamReader クラスは、XML データの転送と「参照のみ」アクセスを可能にするメソッドを提供します。データを XML からプルし、余分なイベントをスキップします。深度が最大 50 ノードのネストされた XML コンテンツを解析できます。

名前空間

System

使用方法

XmlStreamReader クラスは、StAX (Streaming API for XML) の XMLStreamReader ユーティリティクラスと類似しています。StAX は XML ドキュメントに対して読み取りと書き込みを行うための API です。Java プログラミング言語コミュニティで作成されました。

Apex 内の XmlStreamReader クラスは、Java で相当するクラスに基づいています。Java XMLStreamReader クラスを参照してください。

メモ

XmlStreamReader のコンストラクター

XmlStreamReader のコンストラクターは次のとおりです。

XmlStreamReader(xmlInput)

指定された XML 入力の XmlStreamReader クラスの新しいインスタンスを作成します。

署名

public XmlStreamReader(String xmlInput)

パラメーター

xmlInput
型: String
XML 文字列入力。

XmlStreamReader のメソッド

XmlStreamReader のメソッドは次のとおりです。すべてインスタンスメソッドです。

getAttributeCount()

開始要素上の属性の番号 (名前空間の定義は除く) を返します。

署名

public Integer getAttributeCount()

戻り値

型: Integer

使用方法

このメソッドは、開始要素または属性 XML イベント上でのみ有効です。属性 XML イベント用の属性の番号は、0 で始まります。

getAttributeLocalName(index)

指定したインデックスで属性のローカル名を返します。

署名

public String getAttributeLocalName(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

名前がない場合、空白の文字列が返されます。このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getAttributeNamespace(index)

指定したインデックスで属性の名前空間 URI を返します。

署名

public String getAttributeNamespace(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

名前空間が指定されていない場合、null が返されます。このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getAttributePrefix(index)

指定したインデックスでこの属性のプレフィックスを返します。

署名

public String getAttributePrefix(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

プレフィックスが指定されない場合、null が返されます。このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getAttributeType(index)

指定したインデックスで属性の XML の型を返します。

署名

public String getAttributeType(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

たとえば、id は属性型です。このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getAttributeValue(namespaceUri, localName)

特定の URI で指定された localName 内の属性の値を返します。

署名

public String getAttributeValue(String namespaceUri, String localName)

パラメーター

namespaceUri
型: String
localName
型: String

戻り値

型: String

使用方法

値が見つからない場合 null を返します。localName の値を指定する必要があります。このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getAttributeValueAt(index)

指定したインデックスで属性の値を返します。

署名

public String getAttributeValueAt(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

このメソッドは、開始要素または属性 XML イベントでのみ有効です。

getEventType()

カーソルが指し示している XML イベントの型を返します。

署名

public System.XmlTag getEventType()

戻り値

型: System.XmlTag

XmlTag 列挙

XmlTag の値は次のとおりです。

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

getLocalName()

現在のイベントのローカル名を返します。

署名

public String getLocalName()

戻り値

型: String

使用方法

開始または終了要素 XML イベントに関しては、現在の要素のローカル名を返します。エンティティ参照 XML イベントに関しては、エンティティ名を返します。現在の XML イベントは、開始要素、終了要素、またはエンティティ参照である必要があります。

getLocation()

カーソルの現在位置を返します。

署名

public String getLocation()

戻り値

型: String

使用方法

位置が不明な場合、-1 が返されます。位置情報は、next メソッドが呼びだれると無効になります。

getNamespace()

現在のイベントが開始要素または終了要素の場合、このメソッドは、プレフィックスの URI またはデフォルトの名前空間を返します。

署名

public String getNamespace()

戻り値

型: String

使用方法

XML イベントにプレフィックスがない場合、null を返します。

getNamespaceCount()

開始要素または終了要素に宣言された名前空間の数を返します。

署名

public Integer getNamespaceCount()

戻り値

型: Integer

使用方法

このメソッドは、開始要素、終了要素、または名前空間 XML イベント上でのみ有効です。

getNamespacePrefix(index)

インデックスで宣言された名前空間のプレフィックスを返します。

署名

public String getNamespacePrefix(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

これがデフォルトの名前空間宣言の場合、null を返します。このメソッドは、開始要素、終了要素、または名前空間 XML イベント上でのみ有効です。

getNamespaceURI(prefix)

特定のプレフィックス用の URI を返します。

署名

public String getNamespaceURI(String prefix)

パラメーター

prefix
型: String

戻り値

型: String

使用方法

返される URI は、プロセッサーの状態によって異なります。

getNamespaceURIAt(index)

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

署名

public String getNamespaceURIAt(Integer index)

パラメーター

index
型: Integer

戻り値

型: String

使用方法

このメソッドは、開始要素、終了要素、または名前空間 XML イベント上でのみ有効です。

getPIData()

処理方法のデータセクションを返します。

署名

public String getPIData()

戻り値

型: String

getPITarget()

処理方法の対象セクションを返します。

署名

public String getPITarget()

戻り値

型: String

getPrefix()

イベントにプレフィックスがない場合、現在の XML イベントのプレフィックスまたは null を返します。

署名

public String getPrefix()

戻り値

型: String

getText()

文字列として XML イベントの現在の値が返されます。

署名

public String getText()

戻り値

型: String

使用方法

異なるイベントに対する有効値は次のとおりです。

  • 文字 XML イベントの文字列値
  • コメントの文字列値
  • エンティティ参照のための置換値。たとえば、getText が次の XML スニペットを読むとします。
    1<!ENTITY
    2  Title "Salesforce For Dummies" >
    3     ]>
    4  <moo a=\"b\">Name &Title;</moo>';
    getText メソッドは、&Title ではなく、Salesforce for Dummies を返します。
  • CDATA セクションの文字列値
  • 空白 XML イベントの文字列値
  • DTD の内部サブセットの文字列値

getVersion()

XML 宣言で指定された XML バージョンを返します。何も宣言されていない場合、null を返します。

署名

public String getVersion()

戻り値

型: String

hasName()

現在の XML イベントに名前がある場合、true を返します。ない場合は false を返します。

署名

public Boolean hasName()

戻り値

型: Boolean

使用方法

このメソッドは、開始要素または終了要素の XML イベントでのみ有効です。

hasNext()

さらに XML イベントがある場合は true、それ以上 XML イベントがない場合は false を返します。

署名

public Boolean hasNext()

戻り値

型: Boolean

使用方法

現在の XML イベントが終了ドキュメントの場合、このメソッドは、false を返します。

hasText()

現在のイベントにテキストある場合は、true を返し、そうでない場合は、false を返します。

署名

public Boolean hasText()

戻り値

型: Boolean

使用方法

次の XML イベントにはテキストすなわち、文字、エンティティ参照、コメントおよび空白があります。

isCharacters()

カーソルが文字データ XML イベントを指し示している場合、true を返します。ない場合は false を返します。

署名

public Boolean isCharacters()

戻り値

型: Boolean

isEndElement()

カーソルが終了タグを指し示している場合、true を返します。ない場合は false を返します。

署名

public Boolean isEndElement()

戻り値

型: Boolean

isStartElement()

カーソルが開始タグを指し示している場合、true を返します。ない場合は false を返します。

署名

public Boolean isStartElement()

戻り値

型: Boolean

isWhiteSpace()

カーソルが、すべての空白を含む文字データ XML イベントを指し示している場合、true を返します。ない場合は false を返します。

署名

public Boolean isWhiteSpace()

戻り値

型: Boolean

next()

次の XML イベントを読み取ります。プロセッサーは、単一ブロック内のすべての連続文字データを返すか、いつくかのチャンクに分割します。イベントのタイプを示す整数を返します。

署名

public Integer next()

戻り値

型: Integer

nextTag()

(isWhiteSpace メソッドが true を返す) 空白、コメント、または処理命令 XML イベントを、開始要素または終了要素に到達するまでスキップします。XML イベント用のインデックスを返します。

署名

public Integer nextTag()

戻り値

型: Integer

使用方法

空白、コメント、処理命令、開始要素または終了要素以外の要素があると、このメソッドでエラーが生成されます。

setCoalescing(returnAsSingleBlock)

returnAsSingleBlock に対して true を指定した場合、開始要素から最初の終了要素または次の開始要素のいずれか先にくる方に、テキストが単一ブロックで返されます。false と指定した場合は、パーサーは、複数のブロック内でテキストを返します。

署名

public Void setCoalescing(Boolean returnAsSingleBlock)

パラメーター

returnAsSingleBlock
型: Boolean

戻り値

型: Void

setNamespaceAware(isNamespaceAware)

isNamespaceAware に対して true を指定した場合、パーサーは、名前空間を認識します。false として指定した場合、パーサーは認識しません。デフォルト値は true です。

署名

public Void setNamespaceAware(Boolean isNamespaceAware)

パラメーター

isNamespaceAware
型: Boolean

戻り値

型: Void

toString()

XmlStreamReader に指定された入力 XML の長さと入力 XML の最初の 50 文字を含む文字列を返します。

署名

public String toString()

戻り値

型: String