メソッドの詳細

• addChildElement

  SOAPElement addChildElement​(Name name)
                       throws SOAPException

  指定された Name オブジェクトで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。

  この方法は、SAAJ の将来のリリースでは addChildElement(javax.xml.namespace.QName) に置き換えられて非推奨となりる可能性があります。

  パラメーター:

  name - 新しい要素の XML 名を持つ Name オブジェクト

  戻り値:

  作成された新しい SOAPElement オブジェクト

  例外:

  SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

  関連事項:

  addChildElement(javax.xml.namespace.QName)

• addChildElement

  SOAPElement addChildElement​(QNameSE qname)
                       throws SOAPException

  指定された QName オブジェクトで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。新しい SOAPElement の名前空間、 ローカル名、 プレフィックスはすべて、qname 引数から取得されます。

  パラメーター:

  qname - 新しい要素の XML 名を持つ QName オブジェクト

  戻り値:

  作成された新しい SOAPElement オブジェクト

  例外:

  SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

  導入:

  1.6、SAAJ 1.3

  関連事項:

  addChildElement(Name)

• addChildElement

  SOAPElement addChildElement​(StringSE localName)
                       throws SOAPException

  指定されたローカル名で初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。新しい SOAPElement は、スコープ内のデフォルトの名前空間を継承します。

  パラメーター:

  localName - 要素のローカル名を与える String 

  戻り値:

  作成された新しい SOAPElement オブジェクト

  例外:

  SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

• addChildElement

  SOAPElement addChildElement​(StringSE localName,
                              StringSE prefix)
                       throws SOAPException

  指定されたローカル名とプレフィックスで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。

  パラメーター:

  localName - 新しい要素のローカル名を与える String 

  prefix - 新しい要素の名前空間プレフィックスを与える String 

  戻り値:

  作成された新しい SOAPElement オブジェクト

  例外:

  SOAPException - prefix がこの SOAPElement のコンテキストで有効でない場合、または SOAPElement オブジェクトの作成中にエラーが発生した場合

• addChildElement

  SOAPElement addChildElement​(StringSE localName,
                              StringSE prefix,
                              StringSE uri)
                       throws SOAPException

  指定されたローカル名、プレフィックス、URI で初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。

  パラメーター:

  localName - 新しい要素のローカル名を与える String 

  prefix - 新しい要素の名前空間プレフィックスを与える String 

  uri - 新しい要素が属する名前空間の URI を提供する String 

  戻り値:

  作成された新しい SOAPElement オブジェクト

  例外:

  SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

• addChildElement

  SOAPElement addChildElement​(SOAPElement element)
                       throws SOAPException

  この SOAPElement インスタンスの子として SOAPElement を追加します。SOAPElement は、SOAPFactory によって作成されることが期待されています。呼び出し元は、XML ツリーにそのまま追加される要素インスタンスに依存しないでください。実装は、別の SOAPElement 実装のインスタンスに渡された SOAPElement のコンテンツをコピーすることになる可能性があります。たとえば、addChildElement() が SOAPHeader で呼び出された場合、element は SOAPHeaderElement のインスタンスにコピーされます。

  エラーが発生した場合、element をルートとするフラグメントは、全体として追加されるか、まったく追加されません。

  element をルートとするフラグメントには、"Envelope"、"Header"、"Body" という名前の要素を SOAP 名前空間に含めることはできません。フラグメントに存在する名前空間プレフィックスは、フラグメント自体の中で適切な名前空間宣言を使用して完全に解決する必要があります。

  パラメーター:

  element - 新しい子として追加される SOAPElement 

  戻り値:

  実際にツリーに追加された新しい SOAP 要素を表すインスタンス。

  例外:

  SOAPException - この要素を子として追加する際にエラーが発生した場合

• removeContents

  void removeContents()

  この SOAPElement のすべての子を切り離します。

  この方法は、エラー状態が検出されたときに障害を送信する準備として、部分的に完了した SOAPHeaders および SOAPBodys の構築をロールバックできます。また、SOAP メッセージ内のドキュメントの一部をリサイクルする場合にも役立ちます。

  導入:

  1.6、SAAJ 1.2

• addTextNode

  SOAPElement addTextNode​(StringSE text)
                   throws SOAPException

  指定された String で初期化された新しい Text オブジェクトを作成し、それをこの SOAPElement オブジェクトに追加します。

  パラメーター:

  text - 追加するテキストコンテンツを含む String オブジェクト

  戻り値:

  新しい Text オブジェクトが挿入された SOAPElement オブジェクト

  例外:

  SOAPException - 新しい Text オブジェクトの作成中にエラーが発生した場合、または子としてこの SOAPElement にアタッチすることが正当でない場合

• addAttribute

  SOAPElement addAttribute​(Name name,
                           StringSE value)
                    throws SOAPException

  指定された名前と値の属性をこの SOAPElement オブジェクトに追加します。

  パラメーター:

  name - 属性の名前を持つ Name オブジェクト

  value - 属性の値を与える String 

  戻り値:

  属性が挿入された SOAPElement オブジェクト

  例外:

  SOAPException - 属性の作成中にエラーが発生した場合、またはこの SOAPElement で Name name を使用して属性を設定することが無効である場合。

  関連事項:

  addAttribute(javax.xml.namespace.QName, String)

• addAttribute

  SOAPElement addAttribute​(QNameSE qname,
                           StringSE value)
                    throws SOAPException

  指定された名前と値の属性をこの SOAPElement オブジェクトに追加します。

  パラメーター:

  qname - 属性の名前を持つ QName オブジェクト

  value - 属性の値を与える String 

  戻り値:

  属性が挿入された SOAPElement オブジェクト

  例外:

  SOAPException - 属性の作成中にエラーが発生した場合、またはこの SOAPElement で QName qname を使用して属性を設定することが無効である場合。

  導入:

  1.6、SAAJ 1.3

  関連事項:

  addAttribute(Name, String)

• addNamespaceDeclaration

  SOAPElement addNamespaceDeclaration​(StringSE prefix,
                                      StringSE uri)
                               throws SOAPException

  この SOAPElement オブジェクトに、指定されたプレフィックスと URI を持つ名前空間宣言を追加します。

  パラメーター:

  prefix - 名前空間のプレフィックスを与える String 

  uri - 名前空間の URI を与える String 

  戻り値:

  この名前空間宣言が挿入された SOAPElement オブジェクト。

  例外:

  SOAPException - 名前空間の作成中にエラーが発生した場合

• getAttributeValue

  StringSE getAttributeValue​(Name name)

  指定された名前の属性の値を返します。

  パラメーター:

  name - 属性の名前を持つ Name オブジェクト

  戻り値:

  指定された属性の値を与える String、そのような属性がない場合は Null

  関連事項:

  getAttributeValue(javax.xml.namespace.QName)

• getAttributeValue

  StringSE getAttributeValue​(QNameSE qname)

  指定された qname を持つ属性の値を返します。

  パラメーター:

  qname - 属性の qname を持つ QName オブジェクト

  戻り値:

  指定された属性の値を与える String、そのような属性がない場合は Null

  導入:

  1.6、SAAJ 1.3

  関連事項:

  getAttributeValue(Name)

• getAllAttributes

  IteratorSE<Name> getAllAttributes()

  この SOAPElement オブジェクト内のすべての属性 Name オブジェクトに対して Iterator を返します。イテレータを使用して属性名を取得し、それをメソッド getAttributeValue に渡して、各属性の値を取得できます。

  戻り値:

  属性の名前に対するイテレータ

  関連事項:

  getAllAttributesAsQNames()

• getAllAttributesAsQNames

  IteratorSE<QNameSE> getAllAttributesAsQNames()

  この SOAPElement のすべての属性の Iterator を QName オブジェクトとして返します。イテレータを使用して属性 QName を取得し、それをメソッド getAttributeValue に渡して、各属性の値を取得できます。

  戻り値:

  属性の QName に対するイテレータ

  導入:

  1.6、SAAJ 1.3

  関連事項:

  getAllAttributes()

• getNamespaceURI

  StringSE getNamespaceURI​(StringSE prefix)

  指定されたプレフィックスを持つ名前空間の URI を返します。

  パラメーター:

  prefix - 検索する名前空間のプレフィックスを与える String 

  戻り値:

  指定されたプレフィックスを持つ名前空間の URI を持つ String 

• getNamespacePrefixes

  IteratorSE<StringSE> getNamespacePrefixes()

  この要素によって宣言された名前空間プレフィックス String を超える Iterator を返します。このイテレータによって返されるプレフィックスをメソッド getNamespaceURI に渡して、各名前空間の URI を取得できます。

  戻り値:

  この SOAPElement オブジェクトの名前空間プレフィックスに対するイテレータ

• getVisibleNamespacePrefixes

  IteratorSE<StringSE> getVisibleNamespacePrefixes()

  この要素に表示される名前空間プレフィックス String 上の Iterator を返します。このイテレータによって返されるプレフィックスをメソッド getNamespaceURI に渡して、各名前空間の URI を取得できます。

  戻り値:

  名前空間プレフィックスのイテレータは、この SOAPElement オブジェクトのスコープ内にあります

  導入:

  1.6、SAAJ 1.2

• createQName

  QNameSE createQName​(StringSE localName,
                    StringSE prefix)
             throws SOAPException

  この SOAPElement のコンテキストで、名前空間 URI がパラメーター prefix に関連付けられている QName を作成します。新しい QName の残りの要素は、パラメーター localName および prefix から直接取得されます。

  パラメーター:

  localName - 名前のローカル部分を含む String。

  prefix - 名前のプレフィックスを含む String。

  戻り値:

  指定された localName および prefix を持ち、この SOAPElement のコンテキストで prefix に関連付けられている名前空間を持つ QName。この名前空間は、そのパラメーターとして prefix が指定された場合に getNamespaceURI(String) によって返される名前空間と同じになります。

  例外:

  SOAPException - QName を作成できない場合。

  導入:

  1.6、SAAJ 1.3

• getElementName

  Name getElementName()

  この SOAPElement オブジェクトの名前を返します。

  戻り値:

  この SOAPElement オブジェクトの名前を持つ Name オブジェクト

• getElementQName

  QNameSE getElementQName()

  この SOAPElement オブジェクトの qname を返します。

  戻り値:

  この SOAPElement オブジェクトの qname を持つ QName オブジェクト

  導入:

  1.6、SAAJ 1.3

  関連事項:

  getElementName()

• setElementQName

  SOAPElement setElementQName​(QNameSE newName)
                       throws SOAPException

  可能であれば、この Element の名前を newName に変更します。SOAPEnvelope、SOAPHeader、SOAPBody などの SOAP 定義要素は、このメソッドを使用して名前を変更することはできません。これを行おうとすると、SOAPException がスローされます。

  呼び出し元は、要素インスタンスの名前がそのまま変更されていることに依存しないでください。実装により、SOAPElement のコンテンツが名前が変更されたインスタンスにコピーされる可能性があります。

  パラメーター:

  newName - Element の新しい名前。

  戻り値:

  名前が変更されたノード

  例外:

  SOAPException - この Element の名前を変更することが許可されていない場合。

  導入:

  1.6、SAAJ 1.3

• removeAttribute

  boolean removeAttribute​(Name name)

  指定された名前の属性を削除します。

  パラメーター:

  name - 削除する属性の名前を持つ Name オブジェクト

  戻り値:

  属性が正常に削除された場合は true。そうでない場合は false 

  関連事項:

  removeAttribute(javax.xml.namespace.QName)

• removeAttribute

  boolean removeAttribute​(QNameSE qname)

  指定された qname を持つ属性を削除します。

  パラメーター:

  qname - 削除する属性の qname を持つ QName オブジェクト

  戻り値:

  属性が正常に削除された場合は true。そうでない場合は false 

  導入:

  1.6、SAAJ 1.3

  関連事項:

  removeAttribute(Name)

• removeNamespaceDeclaration

  boolean removeNamespaceDeclaration​(StringSE prefix)

  指定されたプレフィックスに対応する名前空間宣言を削除します。

  パラメーター:

  prefix - 検索するプレフィックスを与える String 

  戻り値:

  名前空間宣言が正常に削除された場合は true。そうでない場合は false 

• getChildElements

  IteratorSE<Node> getChildElements()

  この要素の直接の子 Node すべてに対して Iterator を返します。これには、jakarta.xml.soap.Text オブジェクトと SOAPElement オブジェクトが含まれます。

  このメソッドを呼び出すと、子 Element、SOAPElement、org.w3c.dom.Text ノードが、この親ノードの型に応じて SOAPElement、SOAPHeaderElement、SOAPBodyElement または jakarta.xml.soap.Text ノードに置き換えられる必要があります。その結果、呼び出し側アプリケーションは、DOM API を介して取得されたこれらの子ノードへの既存の参照を無効として扱い、破棄するか、この Iterator によって返される値でリフレッシュする必要があります。この動作は、同等の DOMAPI を呼び出すことで回避できます。詳細については、jakarta.xml.soap を参照してください。

  戻り値:

  この SOAPElement オブジェクトのコンテンツを含むイテレータ

• getChildElements

  IteratorSE<Node> getChildElements​(Name name)

  指定された名前を持つこの要素のすべての直接の子 Node に対して Iterator を返します。これらの子はすべて SOAPElement ノードになります。

  このメソッドを呼び出すと、子 Element、SOAPElement、org.w3c.dom.Text ノードが、この親ノードの型に応じて SOAPElement、SOAPHeaderElement、SOAPBodyElement または jakarta.xml.soap.Text ノードに置き換えられる必要があります。その結果、呼び出し側アプリケーションは、DOM API を介して取得されたこれらの子ノードへの既存の参照を無効として扱い、破棄するか、この Iterator によって返される値でリフレッシュする必要があります。この動作は、同等の DOMAPI を呼び出すことで回避できます。詳細については、jakarta.xml.soap を参照してください。

  パラメーター:

  name - 返される子要素の名前を持つ Name オブジェクト

  戻り値:

  指定された名前のこの SOAPElement オブジェクト内のすべての要素に対する Iterator オブジェクト

  関連事項:

  getChildElements(javax.xml.namespace.QName)

• getChildElements

  IteratorSE<Node> getChildElements​(QNameSE qname)

  指定された qname を持つこの要素のすべての直接の子 Node に対して Iterator を返します。これらの子はすべて SOAPElement ノードになります。

  このメソッドを呼び出すと、子 Element、SOAPElement、org.w3c.dom.Text ノードが、この親ノードの型に応じて SOAPElement、SOAPHeaderElement、SOAPBodyElement または jakarta.xml.soap.Text ノードに置き換えられる必要があります。その結果、呼び出し側アプリケーションは、DOM API を介して取得されたこれらの子ノードへの既存の参照を無効として扱い、破棄するか、この Iterator によって返される値でリフレッシュする必要があります。この動作は、同等の DOMAPI を呼び出すことで回避できます。詳細については、jakarta.xml.soap を参照してください。

  パラメーター:

  qname - 返される子要素の qname を持つ QName オブジェクト

  戻り値:

  指定された qname を持つこの SOAPElement オブジェクト内のすべての要素に対する Iterator オブジェクト

  導入:

  1.6、SAAJ 1.3

  関連事項:

  getChildElements(Name)

• setEncodingStyle

  void setEncodingStyle​(StringSE encodingStyle)
                 throws SOAPException

  この SOAPElement オブジェクトのエンコードスタイルを指定されたものに設定します。

  パラメーター:

  encodingStyle - エンコードスタイルを提供する String 

  例外:

  IllegalArgumentExceptionSE - 設定するエンコードスタイルに問題があった場合。

  SOAPException - この SOAPElement に対して encodingStyle の設定が無効である場合。

  関連事項:

  getEncodingStyle()

• getEncodingStyle

  StringSE getEncodingStyle()

  この SOAPElement オブジェクトのエンコードスタイルを返します。

  戻り値:

  エンコードスタイルを提供する String 

  関連事項:

  setEncodingStyle(java.lang.String)