-
- 既知のすべてのサブインタフェース:
Detail
,DetailEntry
,SOAPBody
,SOAPBodyElement
,SOAPEnvelope
,SOAPFault
,SOAPFaultElement
,SOAPHeader
,SOAPHeaderElement
public interface SOAPElement extends Node, Element
SOAPメッセージの要素を示すオブジェクトです。SOAPの仕様で許可されていますが、明確に規定されているわけではありません。 このインタフェースは、SOAP仕様で明確に規定されたオブジェクトの基本インタフェースとしてサービスを実行します。SAAJ固有のオブジェクトを返す必要のあるこのインタフェースのメソッドは、正しい型のオブジェクトを正常に返す必要があるため、ツリー内のノードを通知することなく置き換えます。 詳細については、
getChildElements()
とjavax.xml.soap
を参照してください。- 導入されたバージョン:
- 1.6
-
-
フィールドのサマリー
-
インタフェース 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(QName qname, String value)
指定の名前と値を保持する属性を、このSOAPElement
オブジェクトに追加します。SOAPElement
addAttribute(Name name, String value)
指定の名前と値を保持する属性を、この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
addChildElement(QName qname)
指定のQName
オブジェクトで初期化したSOAPElement
オブジェクトを新しく作成し、その新規要素をこのSOAPElement
オブジェクトに追加します。SOAPElement
addChildElement(Name name)
指定のName
オブジェクトで初期化したSOAPElement
オブジェクトを新しく作成し、その新規要素をこのSOAPElement
オブジェクトに追加します。SOAPElement
addChildElement(SOAPElement element)
この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<Name>
getAllAttributes()
このSOAPElement
オブジェクト内のすべての属性Name
オブジェクトについてのIterator
を返します。Iterator<QName>
getAllAttributesAsQNames()
このSOAPElement
内のすべての属性についてのIterator
をQName
オブジェクトとして返します。String
getAttributeValue(QName qname)
指定されたqnameを保持する属性の値を返します。String
getAttributeValue(Name name)
指定された名前を保持する属性の値を返します。Iterator<Node>
getChildElements()
この要素の直接の子Node
すべてにわたるIterator
を返します。Iterator<Node>
getChildElements(QName qname)
指定のqnameを持つこの要素の直接の子Node
すべてにわたるIterator
を返します。Iterator<Node>
getChildElements(Name name)
指定の名前を持つこの要素の直接の子Node
すべてについてのIterator
を返します。Name
getElementName()
SOAPElement
オブジェクトの名前を返します。QName
getElementQName()
このSOAPElement
オブジェクトのqnameを返します。String
getEncodingStyle()
このSOAPElement
オブジェクトのエンコーディング・スタイルを返します。Iterator<String>
getNamespacePrefixes()
この要素で宣言されている名前空間接頭辞のString
のIterator
を返します。String
getNamespaceURI(String prefix)
指定の接頭辞を持つ名前空間のURIを返します。Iterator<String>
getVisibleNamespacePrefixes()
この要素に表示されている名前空間接頭辞のString
のIterator
を返します。boolean
removeAttribute(QName qname)
指定されたqnameの属性を削除します。boolean
removeAttribute(Name name)
指定された名前の属性を削除します。void
removeContents()
このSOAPElement
のすべての子を切り離します。boolean
removeNamespaceDeclaration(String prefix)
指定の接頭辞に対応した名前空間宣言を削除します。SOAPElement
setElementQName(QName newName)
可能であれば、このElement
の名前をnewName
に変更します。void
setEncodingStyle(String encodingStyle)
このSOAPElement
オブジェクトのエンコーディング・スタイルを指定のものに設定します。-
インタフェース org.w3c.dom.Elementから継承されたメソッド
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
インタフェース javax.xml.soap.Nodeから継承されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
インタフェース 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
の名前空間、ローカル名、および接頭辞は、すべてqname
引数から取得します。- パラメータ:
qname
- 新規要素のXML名を持つQName
オブジェクト- 戻り値:
- 作成された新しい
SOAPElement
オブジェクト - 例外:
SOAPException
-SOAPElement
オブジェクトの作成時にエラーが発生した場合- 導入されたバージョン:
- 1.6, 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メッセージ内のドキュメントの一部の再利用にも役立ちます。- 導入されたバージョン:
- 1.6, 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
- 属性の作成でエラーが発生した場合、またはName
name
を持つ属性をこのSOAPElementに設定することが無効な場合。- 関連項目:
addAttribute(javax.xml.namespace.QName, String)
-
addAttribute
SOAPElement addAttribute(QName qname, String value) throws SOAPException
指定の名前と値を保持する属性を、このSOAPElement
オブジェクトに追加します。- パラメータ:
qname
- 属性名を持つQName
オブジェクトvalue
- 属性値を提供するString
- 戻り値:
- 属性が挿入された
SOAPElement
オブジェクト - 例外:
SOAPException
- 属性の作成でエラーが発生した場合、またはQName
qname
を持つ属性をこのSOAPElementに設定することが無効な場合。- 導入されたバージョン:
- 1.6, 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 - 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
getAttributeValue(Name)
-
getAllAttributes
Iterator<Name> getAllAttributes()
このSOAPElement
オブジェクト内のすべての属性Name
オブジェクトについてのIterator
を返します。 イテレータは属性名の取得に使用し、getAttributeValue
メソッドへ渡して各属性の値を取得できます。- 戻り値:
- 属性名のイテレータ
- 関連項目:
getAllAttributesAsQNames()
-
getAllAttributesAsQNames
Iterator<QName> getAllAttributesAsQNames()
このSOAPElement
内のすべての属性についてのIterator
をQName
オブジェクトとして返します。 イテレータは属性QNameの取得に使用し、getAttributeValue
メソッドへ渡して各属性の値を取得できます。- 戻り値:
- 属性のQNameのイテレータ
- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
getAllAttributes()
-
getNamespaceURI
String getNamespaceURI(String prefix)
指定の接頭辞を持つ名前空間のURIを返します。- パラメータ:
prefix
- 検索する名前空間の接頭辞を指定するString
- 戻り値:
- 指定の接頭辞を持つ名前空間のURIを保持する
String
-
getNamespacePrefixes
Iterator<String> getNamespacePrefixes()
この要素で宣言されている名前空間接頭辞のString
のIterator
を返します。 このイテレータで返された接頭辞をgetNamespaceURI
メソッドに渡し、各名前空間のURIを取得できます。- 戻り値:
- この
SOAPElement
オブジェクトの名前空間接頭辞のイテレータ
-
getVisibleNamespacePrefixes
Iterator<String> getVisibleNamespacePrefixes()
この要素に表示されている名前空間接頭辞のString
のIterator
を返します。 このイテレータで返された接頭辞をgetNamespaceURI
メソッドに渡し、各名前空間のURIを取得できます。- 戻り値:
- この
SOAPElement
オブジェクトのスコープ内にある名前空間接頭辞のイテレータ - 導入されたバージョン:
- 1.6, 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
を作成できない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getElementName
Name getElementName()
SOAPElement
オブジェクトの名前を返します。- 戻り値:
- この
SOAPElement
オブジェクトの名前を持つName
オブジェクト
-
getElementQName
QName getElementQName()
このSOAPElement
オブジェクトのqnameを返します。- 戻り値:
- この
SOAPElement
オブジェクトのqnameを持つQName
オブジェクト - 導入されたバージョン:
- 1.6, 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
の名前変更が許可されていない場合。- 導入されたバージョン:
- 1.6, 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
- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
removeAttribute(Name)
-
removeNamespaceDeclaration
boolean removeNamespaceDeclaration(String prefix)
指定の接頭辞に対応した名前空間宣言を削除します。- パラメータ:
prefix
- 検索する接頭辞を指定するString
- 戻り値:
- 名前空間宣言が正常に削除された場合は
true
、正常に削除されなかった場合はfalse
-
getChildElements
Iterator<Node> getChildElements()
この要素の直接の子Node
すべてにわたるIterator
を返します。 これにはSOAPElement
オブジェクトだけでなくjavax.xml.soap.Text
オブジェクトも含まれます。このメソッドを呼び出すと、子ノード
Element
、SOAPElement
、およびorg.w3c.dom.Text
ノードが、この親ノードのタイプに応じて、SOAPElement
、SOAPHeaderElement
、SOAPBodyElement
またはjavax.xml.soap.Text
ノードに置き換えられる必要があります。 結果として、アプリケーションを呼び出す場合、DOM APIで取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、このIterator
で返された値でリフレッシュする必要があります。 この動作は、同等のDOM APIを呼び出すことで回避できます。 詳細はjavax.xml.soap
を参照してください。- 戻り値:
- この
SOAPElement
オブジェクトのコンテンツを持つイテレータ
-
getChildElements
Iterator<Node> getChildElements(Name name)
指定の名前を持つこの要素の直接の子Node
すべてについてのIterator
を返します。 これらの子はすべてSOAPElement
ノードになります。このメソッドを呼び出すと、子ノード
Element
、SOAPElement
、およびorg.w3c.dom.Text
ノードが、この親ノードのタイプに応じて、SOAPElement
、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<Node> getChildElements(QName qname)
指定のqnameを持つこの要素の直接の子Node
すべてにわたるIterator
を返します。 これらの子はすべてSOAPElement
ノードになります。このメソッドを呼び出すと、子ノード
Element
、SOAPElement
、およびorg.w3c.dom.Text
ノードが、この親ノードのタイプに応じて、SOAPElement
、SOAPHeaderElement
、SOAPBodyElement
またはjavax.xml.soap.Text
ノードに置き換えられる必要があります。 結果として、アプリケーションを呼び出す場合、DOM APIで取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、このIterator
で返された値でリフレッシュする必要があります。 この動作は、同等のDOM APIを呼び出すことで回避できます。 詳細はjavax.xml.soap
を参照してください。- パラメータ:
qname
- 返される子要素のqnameを持つQName
オブジェクト- 戻り値:
- 指定のqnameを持つこの
SOAPElement
オブジェクトの要素すべてにわたるIterator
オブジェクト - 導入されたバージョン:
- 1.6, 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)
-
-