javax.xml.soap
インタフェース SOAPElement

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

Element, Node

既知のサブインタフェースの一覧:

Detail, DetailEntry, SOAPBody, SOAPBodyElement, SOAPEnvelope, SOAPFault, SOAPFaultElement, SOAPHeader, SOAPHeaderElement

public interface SOAPElement
extends Node, Element

SOAP メッセージの要素を示すオブジェクトです。SOAP の仕様で許可されていますが、明確に規定されているわけではありません。このインタフェースは、SOAP 仕様で明確に規定されたオブジェクトの基本インタフェースとしてサービスを実行します。

SAAJ 固有のオブジェクトを返す必要のあるこのインタフェースのメソッドは、正しい型のオブジェクトを正常に返す必要があるため、ツリー内のノードを通知することなく置き換えます。詳細については、getChildElements() および javax.xml.soap を参照してください。

フィールドの概要

インタフェース org.w3c.dom.Node から継承されたフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

メソッドの概要

SOAPElement	addAttribute(Name name, String value) 指定の名前と値を保持する属性を、この SOAPElement オブジェクトに追加します。
SOAPElement	addAttribute(QName qname, String value) 指定の名前と値を保持する属性を、この SOAPElement オブジェクトに追加します。
SOAPElement	addChildElement(Name name) 指定の Name オブジェクトで初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。
SOAPElement	addChildElement(QName qname) 指定の QName オブジェクトで初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。
SOAPElement	addChildElement(SOAPElement element) この SOAPElement インスタンスの子として SOAPElement を追加します。
SOAPElement	addChildElement(String localName) 指定のローカル名で初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。
SOAPElement	addChildElement(String localName, String prefix) 指定のローカル名と接頭辞で初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。
SOAPElement	addChildElement(String localName, String prefix, String uri) 指定のローカル名、接頭辞、および URI で初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。
SOAPElement	addNamespaceDeclaration(String prefix, String uri) 指定の接頭辞と URI を保持する名前空間宣言を、この SOAPElement オブジェクトに追加します。
SOAPElement	addTextNode(String text) 指定の String で初期化した Text オブジェクトを新しく作成し、この SOAPElement オブジェクトに追加します。
QName	createQName(String localName, String prefix) 名前空間 URI が、この SOAPElement のコンテキストのパラメータ、prefix、に関連している QName を作成します。
Iterator	getAllAttributes() この SOAPElement オブジェクトの属性 Name オブジェクトのすべてにわたる Iterator を返します。
Iterator	getAllAttributesAsQNames() この SOAPElement の属性すべてにわたる Iterator を QName オブジェクトとして返します。
String	getAttributeValue(Name name) 指定された名前を保持する属性の値を返します。
String	getAttributeValue(QName qname) 指定された qname を保持する属性の値を返します。
Iterator	getChildElements() この要素の直接の子 Node すべてにわたる Iterator を返します。
Iterator	getChildElements(Name name) 指定の名前を持つこの要素の直接の子 Node すべてにわたる Iterator を返します。
Iterator	getChildElements(QName qname) 指定の qname を持つこの要素の直接の子 Node すべてにわたる Iterator を返します。
Name	getElementName() この SOAPElement オブジェクトの名前を返します。
QName	getElementQName() この SOAPElement オブジェクトの qname を返します。
String	getEncodingStyle() この SOAPElement オブジェクトのエンコーディングスタイルを返します。
Iterator	getNamespacePrefixes() この要素で宣言されている名前空間接頭辞の String の Iterator を返します。
String	getNamespaceURI(String prefix) 指定の接頭辞を持つ名前空間の URI を返します。
Iterator	getVisibleNamespacePrefixes() この要素に表示されている名前空間接頭辞の String の Iterator を返します。
boolean	removeAttribute(Name name) 指定された名前の属性を削除します。
boolean	removeAttribute(QName qname) 指定された qname の属性を削除します。
void	removeContents() この SOAPElement のすべての子を切り離します。
boolean	removeNamespaceDeclaration(String prefix) 指定の接頭辞に対応した名前空間宣言を削除します。
SOAPElement	setElementQName(QName newName) 可能であれば、この Element の名前を newName に変更します。
void	setEncodingStyle(String encodingStyle) この SOAPElement オブジェクトのエンコーディングスタイルを指定のものに設定します。

インタフェース javax.xml.soap.Node から継承されたメソッド

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

インタフェース org.w3c.dom.Element から継承されたメソッド

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

インタフェース org.w3c.dom.Node から継承されたメソッド

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

メソッドの詳細

addChildElement

SOAPElement addChildElement(Name name)
                            throws SOAPException

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

このメソッドは、addChildElement(javax.xml.namespace.QName) との関係で、SAAJ の将来のリリースで推奨されなくなる可能性があります。

パラメータ:

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

戻り値:

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

例外:

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

関連項目:

addChildElement(javax.xml.namespace.QName)

addChildElement

SOAPElement addChildElement(QName qname)
                            throws SOAPException

指定の QName オブジェクトで初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。新しい SOAPElement のnamespace、localname、およびprefixは、すべて qname 引数から取得します。

パラメータ:

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

戻り値:

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

例外:

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

導入されたバージョン:

SAAJ 1.3

関連項目:

addChildElement(Name)

addChildElement

SOAPElement addChildElement(String localName)
                            throws SOAPException

指定のローカル名で初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。新しい SOAPElement は、デフォルトの名前空間の範囲をすべて継承しています。

パラメータ:

localName - 要素のローカル名を提供する String

戻り値:

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

例外:

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

addChildElement

SOAPElement addChildElement(String localName,
                            String prefix)
                            throws SOAPException

指定のローカル名と接頭辞で初期化した SOAPElement オブジェクトを新しく作成し、その新規要素をこの SOAPElement オブジェクトに追加します。

パラメータ:

localName - 新規要素のローカル名を提供する String

prefix - 新規要素の名前空間の接頭辞を提供する String

戻り値:

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

例外:

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

addChildElement

SOAPElement addChildElement(String localName,
                            String prefix,
                            String 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 にルートされたフラグメントには全体が追加されます。ただし、エラーが発生した場合は 1 つも追加されません。 　

element にルートされたフラグメントには、SOAP 名前空間に "Envelope"、"Header"、"Body" という名前の要素を保有できません。フラグメントに存在する名前空間の接頭辞は、そのフラグメント内部で適切な名前空間宣言を使用して完全に解決される必要があります。

パラメータ:

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

戻り値:

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

例外:

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

removeContents

void removeContents()

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

このメソッドは、エラー状態の検出時にエラーを送信する準備として、SOAPHeaders や SOAPBodys を構築が完成している部分までロールバックするのに役立ちます。また、SOAP メッセージ内のドキュメントの一部の再利用にも役立ちます。

導入されたバージョン:

SAAJ 1.2

addTextNode

SOAPElement addTextNode(String text)
                        throws SOAPException

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

パラメータ:

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

戻り値:

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

例外:

SOAPException - 新しい Text オブジェクトの作成時に エラーが発生した場合、またはこの SOAPElement に 子として添付することが 許可されていない場合

addAttribute

SOAPElement addAttribute(Name name,
                         String value)
                         throws SOAPException

指定の名前と値を保持する属性を、この SOAPElement オブジェクトに追加します。

パラメータ:

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

value - 属性値を提供する String

戻り値:

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

例外:

SOAPException - Attribute の作成時にエラーが発生した場合、 またはこの SOAPElement に Name name の属性を 設定することが無効な場合

関連項目:

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

addAttribute

SOAPElement addAttribute(QName qname,
                         String value)
                         throws SOAPException

指定の名前と値を保持する属性を、この SOAPElement オブジェクトに追加します。

パラメータ:

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

value - 属性値を提供する String

戻り値:

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

例外:

SOAPException - Attribute の作成時にエラーが発生した場合、 またはこの SOAPElement に QName qname の属性を 設定することが無効な場合

導入されたバージョン:

SAAJ 1.3

関連項目:

addAttribute(Name, String)

addNamespaceDeclaration

SOAPElement addNamespaceDeclaration(String prefix,
                                    String uri)
                                    throws SOAPException

指定の接頭辞と URI を保持する名前空間宣言を、この SOAPElement オブジェクトに追加します。

パラメータ:

prefix - 名前空間の接頭辞を提供する String

uri - 名前空間の URI を提供する String

戻り値:

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

例外:

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

getAttributeValue

String getAttributeValue(Name name)

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

パラメータ:

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

戻り値:

指定の属性値を提供する String、 またはそのような属性がない場合は Null

関連項目:

getAttributeValue(javax.xml.namespace.QName)

getAttributeValue

String getAttributeValue(QName qname)

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

パラメータ:

qname - 属性の qname を保有する QName オブジェクト

戻り値:

指定の属性値を提供する String、 またはそのような属性がない場合は Null

導入されたバージョン:

SAAJ 1.3

関連項目:

getAttributeValue(Name)

getAllAttributes

Iterator getAllAttributes()

この SOAPElement オブジェクトの属性 Name オブジェクトのすべてにわたる Iterator を返します。反復子は属性名の取得に使用し、getAttributeValue メソッドへ渡して各属性の値を取得できます。

戻り値:

属性名の反復子

関連項目:

getAllAttributesAsQNames()

getAllAttributesAsQNames

Iterator getAllAttributesAsQNames()

この SOAPElement の属性すべてにわたる Iterator を QName オブジェクトとして返します。反復子は属性 QName の取得に使用し、getAttributeValue メソッドへ渡して各属性の値を取得できます。

戻り値:

属性の QName の反復子

導入されたバージョン:

SAAJ 1.3

関連項目:

getAllAttributes()

getNamespaceURI

String getNamespaceURI(String prefix)

指定の接頭辞を持つ名前空間の URI を返します。

パラメータ:

prefix - 検索する名前空間の接頭辞を提供する String

戻り値:

指定の接頭辞を持つ名前空間の URI を保有する String

getNamespacePrefixes

Iterator getNamespacePrefixes()

この要素で宣言されている名前空間接頭辞の String の Iterator を返します。この反復子で返された接頭辞を getNamespaceURI メソッドに渡し、各名前空間の URI を取得できます。

戻り値:

この SOAPElement オブジェクトの名前空間接頭辞の 反復子

getVisibleNamespacePrefixes

Iterator getVisibleNamespacePrefixes()

この要素に表示されている名前空間接頭辞の String の Iterator を返します。この反復子で返された接頭辞を getNamespaceURI メソッドに渡し、各名前空間の URI を取得できます。

戻り値:

この SOAPElement オブジェクトのスコープ内にある名前空間接頭辞の 反復子

導入されたバージョン:

SAAJ 1.2

createQName

QName createQName(String localName,
                  String prefix)
                  throws SOAPException

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

パラメータ:

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

prefix - 名前の接頭辞を含む String

戻り値:

指定の localName と prefix、および、この SOAPElement のコンテキストの prefix に関連した名前空間を持つ QName。パラメータとして prefix が指定されている場合、 この名前空間は、 getNamespaceURI(String) に返される ものと同一である

例外:

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

導入されたバージョン:

SAAJ 1.3

getElementName

Name getElementName()

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

戻り値:

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

getElementQName

QName getElementQName()

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

戻り値:

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

導入されたバージョン:

SAAJ 1.3

関連項目:

getElementName()

setElementQName

SOAPElement setElementQName(QName newName)
                            throws SOAPException

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

呼び出し側は、そのまま名前変更される要素インスタンスを信用してはいけません。SOAPElement のコンテンツを、名前変更したインスタンスにコピーして実装が終わる可能性があります。

パラメータ:

newName - Element の新しい名前

戻り値:

名前が変更された Node

例外:

SOAPException - この Element の名前変更が 許可されていない場合

導入されたバージョン:

SAAJ 1.3

removeAttribute

boolean removeAttribute(Name name)

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

パラメータ:

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

戻り値:

属性が正常に削除された場合は true、 正常に削除されなかった場合は false

関連項目:

removeAttribute(javax.xml.namespace.QName)

removeAttribute

boolean removeAttribute(QName qname)

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

パラメータ:

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

戻り値:

属性が正常に削除された場合は true、 正常に削除されなかった場合は false

導入されたバージョン:

SAAJ 1.3

関連項目:

removeAttribute(Name)

removeNamespaceDeclaration

boolean removeNamespaceDeclaration(String prefix)

指定の接頭辞に対応した名前空間宣言を削除します。

パラメータ:

prefix - 検索する接頭辞を提供する String

戻り値:

名前空間宣言が正常に削除された場合は true、 正常に削除されなかった場合は false

getChildElements

Iterator getChildElements()

この要素の直接の子 Node すべてにわたる Iterator を返します。これには SOAPElement オブジェクトだけでなく javax.xml.soap.Text も含まれます。

このメソッドを呼び出すと、子の Element、SOAPElement、SOAPElement に置換される org.w3c.dom.Text ノード、SOAPHeaderElement、SOAPBodyElement、この親ノードのタイプに適切な javax.xml.soap.Text ノードが発生します。結果として、アプリケーションを呼び出す場合、DOM API で取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、この Iterator で返された値でリフレッシュする必要があります。この動作は、同等の DOM API を呼び出すことで回避できます。詳細については、javax.xml.soap を参照してください。

戻り値:

この SOAPElement オブジェクトのコンテンツを持つ 反復子

getChildElements

Iterator getChildElements(Name name)

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

このメソッドを呼び出すと、子の Element、SOAPElement、SOAPElement に置換される org.w3c.dom.Text ノード、SOAPHeaderElement、SOAPBodyElement、この親ノードのタイプに適切な javax.xml.soap.Text ノードが発生します。結果として、アプリケーションを呼び出す場合、DOM API で取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、この Iterator で返された値でリフレッシュする必要があります。この動作は、同等の DOM API を呼び出すことで回避できます。詳細については、javax.xml.soap を参照してください。

パラメータ:

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

戻り値:

指定の名前を持つこの SOAPElement オブジェクトの 要素すべてにわたる Iterator オブジェクト

関連項目:

getChildElements(javax.xml.namespace.QName)

getChildElements

Iterator getChildElements(QName qname)

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

このメソッドを呼び出すと、子の Element、SOAPElement、SOAPElement に置換される org.w3c.dom.Text ノード、SOAPHeaderElement、SOAPBodyElement、この親ノードのタイプに適切な javax.xml.soap.Text ノードが発生します。結果として、アプリケーションを呼び出す場合、DOM API で取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、この Iterator で返された値でリフレッシュする必要があります。この動作は、同等の DOM API を呼び出すことで回避できます。詳細については、javax.xml.soap を参照してください。

パラメータ:

qname - 返される子要素の qname を保有する QName オブジェクト

戻り値:

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

導入されたバージョン:

SAAJ 1.3

関連項目:

getChildElements(Name)

setEncodingStyle

void setEncodingStyle(String encodingStyle)
                      throws SOAPException

この SOAPElement オブジェクトのエンコーディングスタイルを指定のものに設定します。

パラメータ:

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

例外:

IllegalArgumentException - 設定されているエンコーディングスタイルに 問題が発生した場合

SOAPException - この SOAPElement に対する encodingStyle の設定が無効の場合

関連項目:

getEncodingStyle()

getEncodingStyle

String getEncodingStyle()

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

戻り値:

エンコーディングスタイルを提供する String

関連項目:

setEncodingStyle(java.lang.String)