public interface SOAPElement extends Node, ElementSE
SAAJ 固有のオブジェクトを返すために必要なこのインターフェースのメソッドは、正しい型のオブジェクトを正常に返すために必要に応じて、ツリー内のノードを「サイレントに」置き換えることができます。詳細については、getChildElements()
および jakarta.xml.soap
を参照してください。
ATTRIBUTE_NODESE, CDATA_SECTION_NODESE, COMMENT_NODESE, DOCUMENT_FRAGMENT_NODESE, DOCUMENT_NODESE, DOCUMENT_POSITION_CONTAINED_BYSE, DOCUMENT_POSITION_CONTAINSSE, DOCUMENT_POSITION_DISCONNECTEDSE, DOCUMENT_POSITION_FOLLOWINGSE, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFICSE, DOCUMENT_POSITION_PRECEDINGSE, DOCUMENT_TYPE_NODESE, ELEMENT_NODESE, ENTITY_NODESE, ENTITY_REFERENCE_NODESE, NOTATION_NODESE, PROCESSING_INSTRUCTION_NODESE, TEXT_NODESE
修飾子と型 | メソッドと説明 |
---|---|
SOAPElement | addAttribute(Name name, StringSE value) 指定された名前と値の属性をこの SOAPElement オブジェクトに追加します。 |
SOAPElement | addAttribute(QNameSE qname, StringSE value) 指定された名前と値の属性をこの SOAPElement オブジェクトに追加します。 |
SOAPElement | addChildElement(Name name) 指定された Name オブジェクトで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。 |
SOAPElement | addChildElement(QNameSE qname) 指定された QName オブジェクトで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。 |
SOAPElement | addChildElement(SOAPElement element) この SOAPElement インスタンスの子として SOAPElement を追加します。 |
SOAPElement | addChildElement(StringSE localName) 指定されたローカル名で初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。 |
SOAPElement | addChildElement(StringSE localName, StringSE prefix) 指定されたローカル名とプレフィックスで初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。 |
SOAPElement | addChildElement(StringSE localName, StringSE prefix, StringSE uri) 指定されたローカル名、プレフィックス、URI で初期化された新しい SOAPElement オブジェクトを作成し、この SOAPElement オブジェクトに新しい要素を追加します。 |
SOAPElement | addNamespaceDeclaration(StringSE prefix, StringSE uri) この SOAPElement オブジェクトに、指定されたプレフィックスと URI を持つ名前空間宣言を追加します。 |
SOAPElement | addTextNode(StringSE text) 指定された String で初期化された新しい Text オブジェクトを作成し、それをこの SOAPElement オブジェクトに追加します。 |
QNameSE | createQName(StringSE localName, StringSE prefix) この SOAPElement のコンテキストで、名前空間 URI がパラメーター prefix に関連付けられている QName を作成します。 |
IteratorSE<Name> | getAllAttributes() この SOAPElement オブジェクト内のすべての属性 Name オブジェクトに対して Iterator を返します。 |
IteratorSE<QNameSE> | getAllAttributesAsQNames() この SOAPElement のすべての属性の Iterator を QName オブジェクトとして返します。 |
StringSE | getAttributeValue(Name name) 指定された名前の属性の値を返します。 |
StringSE | getAttributeValue(QNameSE qname) 指定された qname を持つ属性の値を返します。 |
IteratorSE<Node> | getChildElements() この要素のすべての直接の子 Node に対して Iterator を返します。 |
IteratorSE<Node> | getChildElements(Name name) 指定された名前を持つこの要素のすべての直接の子 Node に対して Iterator を返します。 |
IteratorSE<Node> | getChildElements(QNameSE qname) 指定された qname を持つこの要素のすべての直接の子 Node に対して Iterator を返します。 |
Name | getElementName() この SOAPElement オブジェクトの名前を返します。 |
QNameSE | getElementQName() この SOAPElement オブジェクトの qname を返します。 |
StringSE | getEncodingStyle() この SOAPElement オブジェクトのエンコードスタイルを返します。 |
IteratorSE<StringSE> | getNamespacePrefixes() この要素によって宣言された名前空間プレフィックス String を超える Iterator を返します。 |
StringSE | getNamespaceURI(StringSE prefix) 指定されたプレフィックスを持つ名前空間の URI を返します。 |
IteratorSE<StringSE> | getVisibleNamespacePrefixes() この要素に表示される名前空間プレフィックス String 上の Iterator を返します。 |
boolean | removeAttribute(Name name) 指定された名前の属性を削除します。 |
boolean | removeAttribute(QNameSE qname) 指定された qname を持つ属性を削除します。 |
void | removeContents() この SOAPElement のすべての子を切り離します。 |
boolean | removeNamespaceDeclaration(StringSE prefix) 指定されたプレフィックスに対応する名前空間宣言を削除します。 |
SOAPElement | setElementQName(QNameSE newName) 可能であれば、この Element の名前を newName に変更します。 |
void | setEncodingStyle(StringSE encodingStyle) この SOAPElement オブジェクトのエンコードスタイルを指定されたものに設定します。 |
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
getAttributeSE, getAttributeNodeSE, getAttributeNodeNSSE, getAttributeNSSE, getElementsByTagNameSE, getElementsByTagNameNSSE, getSchemaTypeInfoSE, getTagNameSE, hasAttributeSE, hasAttributeNSSE, removeAttributeSE, removeAttributeNodeSE, removeAttributeNSSE, setAttributeSE, setAttributeNodeSE, setAttributeNodeNSSE, setAttributeNSSE, setIdAttributeSE, setIdAttributeNodeSE, setIdAttributeNSSE
appendChildSE, cloneNodeSE, compareDocumentPositionSE, getAttributesSE, getBaseURISE, getChildNodesSE, getFeatureSE, getFirstChildSE, getLastChildSE, getLocalNameSE, getNamespaceURISE, getNextSiblingSE, getNodeNameSE, getNodeTypeSE, getNodeValueSE, getOwnerDocumentSE, getParentNodeSE, getPrefixSE, getPreviousSiblingSE, getTextContentSE, getUserDataSE, hasAttributesSE, hasChildNodesSE, insertBeforeSE, isDefaultNamespaceSE, isEqualNodeSE, isSameNodeSE, isSupportedSE, lookupNamespaceURISE, lookupPrefixSE, normalizeSE, removeChildSE, replaceChildSE, setNodeValueSE, setPrefixSE, setTextContentSE, setUserDataSE
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)
SOAPElement addChildElement(QNameSE qname) throws SOAPException
QName
オブジェクトで初期化された新しい SOAPElement
オブジェクトを作成し、この SOAPElement
オブジェクトに新しい要素を追加します。新しい SOAPElement
の名前空間、 ローカル名、 プレフィックスはすべて、qname
引数から取得されます。qname
- 新しい要素の XML 名を持つ QName
オブジェクト SOAPElement
オブジェクト SOAPException
- SOAPElement
オブジェクトの作成中にエラーが発生した場合 addChildElement(Name)
SOAPElement addChildElement(StringSE localName) throws SOAPException
SOAPElement
オブジェクトを作成し、この SOAPElement
オブジェクトに新しい要素を追加します。新しい SOAPElement
は、スコープ内のデフォルトの名前空間を継承します。localName
- 要素のローカル名を与える String
SOAPElement
オブジェクト SOAPException
- SOAPElement
オブジェクトの作成中にエラーが発生した場合 SOAPElement addChildElement(StringSE localName, StringSE prefix) throws SOAPException
SOAPElement
オブジェクトを作成し、この SOAPElement
オブジェクトに新しい要素を追加します。localName
- 新しい要素のローカル名を与える String
prefix
- 新しい要素の名前空間プレフィックスを与える String
SOAPElement
オブジェクト SOAPException
- prefix
がこの SOAPElement
のコンテキストで有効でない場合、または SOAPElement
オブジェクトの作成中にエラーが発生した場合 SOAPElement addChildElement(StringSE localName, StringSE prefix, StringSE uri) throws SOAPException
SOAPElement
オブジェクトを作成し、この SOAPElement
オブジェクトに新しい要素を追加します。localName
- 新しい要素のローカル名を与える String
prefix
- 新しい要素の名前空間プレフィックスを与える String
uri
- 新しい要素が属する名前空間の URI を提供する String
SOAPElement
オブジェクト SOAPException
- SOAPElement
オブジェクトの作成中にエラーが発生した場合 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
SOAPException
- この要素を子として追加する際にエラーが発生した場合 void removeContents()
SOAPElement
のすべての子を切り離します。 この方法は、エラー状態が検出されたときに障害を送信する準備として、部分的に完了した SOAPHeaders
および SOAPBodys
の構築をロールバックできます。また、SOAP メッセージ内のドキュメントの一部をリサイクルする場合にも役立ちます。
SOAPElement addTextNode(StringSE text) throws SOAPException
String
で初期化された新しい Text
オブジェクトを作成し、それをこの SOAPElement
オブジェクトに追加します。text
- 追加するテキストコンテンツを含む String
オブジェクト Text
オブジェクトが挿入された SOAPElement
オブジェクト SOAPException
- 新しい Text
オブジェクトの作成中にエラーが発生した場合、または子としてこの SOAPElement
にアタッチすることが正当でない場合 SOAPElement addAttribute(Name name, StringSE value) throws SOAPException
SOAPElement
オブジェクトに追加します。name
- 属性の名前を持つ Name
オブジェクト value
- 属性の値を与える String
SOAPElement
オブジェクト SOAPException
- 属性の作成中にエラーが発生した場合、またはこの SOAPElement で Name
name
を使用して属性を設定することが無効である場合。addAttribute(javax.xml.namespace.QName, String)
SOAPElement addAttribute(QNameSE qname, StringSE value) throws SOAPException
SOAPElement
オブジェクトに追加します。qname
- 属性の名前を持つ QName
オブジェクト value
- 属性の値を与える String
SOAPElement
オブジェクト SOAPException
- 属性の作成中にエラーが発生した場合、またはこの SOAPElement で QName
qname
を使用して属性を設定することが無効である場合。addAttribute(Name, String)
SOAPElement addNamespaceDeclaration(StringSE prefix, StringSE uri) throws SOAPException
SOAPElement
オブジェクトに、指定されたプレフィックスと URI を持つ名前空間宣言を追加します。prefix
- 名前空間のプレフィックスを与える String
uri
- 名前空間の URI を与える String
SOAPElement
オブジェクト。SOAPException
- 名前空間の作成中にエラーが発生した場合 StringSE getAttributeValue(Name name)
name
- 属性の名前を持つ Name
オブジェクト String
、そのような属性がない場合は NullgetAttributeValue(javax.xml.namespace.QName)
StringSE getAttributeValue(QNameSE qname)
qname
- 属性の qname を持つ QName
オブジェクト String
、そのような属性がない場合は NullgetAttributeValue(Name)
IteratorSE<Name> getAllAttributes()
SOAPElement
オブジェクト内のすべての属性 Name
オブジェクトに対して Iterator
を返します。イテレータを使用して属性名を取得し、それをメソッド getAttributeValue
に渡して、各属性の値を取得できます。getAllAttributesAsQNames()
IteratorSE<QNameSE> getAllAttributesAsQNames()
SOAPElement
のすべての属性の Iterator
を QName
オブジェクトとして返します。イテレータを使用して属性 QName を取得し、それをメソッド getAttributeValue
に渡して、各属性の値を取得できます。getAllAttributes()
StringSE getNamespaceURI(StringSE prefix)
prefix
- 検索する名前空間のプレフィックスを与える String
String
IteratorSE<StringSE> getNamespacePrefixes()
String
を超える Iterator
を返します。このイテレータによって返されるプレフィックスをメソッド getNamespaceURI
に渡して、各名前空間の URI を取得できます。SOAPElement
オブジェクトの名前空間プレフィックスに対するイテレータ IteratorSE<StringSE> getVisibleNamespacePrefixes()
String
上の Iterator
を返します。このイテレータによって返されるプレフィックスをメソッド getNamespaceURI
に渡して、各名前空間の URI を取得できます。SOAPElement
オブジェクトのスコープ内にあります 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
を作成できない場合。Name getElementName()
SOAPElement
オブジェクトの名前を返します。SOAPElement
オブジェクトの名前を持つ Name
オブジェクト QNameSE getElementQName()
SOAPElement
オブジェクトの qname を返します。SOAPElement
オブジェクトの qname を持つ QName
オブジェクト getElementName()
SOAPElement setElementQName(QNameSE newName) throws SOAPException
Element
の名前を newName
に変更します。SOAPEnvelope、SOAPHeader、SOAPBody などの SOAP 定義要素は、このメソッドを使用して名前を変更することはできません。これを行おうとすると、SOAPException がスローされます。 呼び出し元は、要素インスタンスの名前がそのまま変更されていることに依存しないでください。実装により、SOAPElement
のコンテンツが名前が変更されたインスタンスにコピーされる可能性があります。
newName
- Element
の新しい名前。SOAPException
- この Element
の名前を変更することが許可されていない場合。boolean removeAttribute(Name name)
name
- 削除する属性の名前を持つ Name
オブジェクト true
。そうでない場合は false
removeAttribute(javax.xml.namespace.QName)
boolean removeAttribute(QNameSE qname)
qname
- 削除する属性の qname を持つ QName
オブジェクト true
。そうでない場合は false
removeAttribute(Name)
boolean removeNamespaceDeclaration(StringSE prefix)
prefix
- 検索するプレフィックスを与える String
true
。そうでない場合は false
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
オブジェクトのコンテンツを含むイテレータ 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)
IteratorSE<Node> getChildElements(QNameSE 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
オブジェクト SOAPElement
オブジェクト内のすべての要素に対する Iterator
オブジェクト getChildElements(Name)
void setEncodingStyle(StringSE encodingStyle) throws SOAPException
SOAPElement
オブジェクトのエンコードスタイルを指定されたものに設定します。encodingStyle
- エンコードスタイルを提供する String
IllegalArgumentExceptionSE
- 設定するエンコードスタイルに問題があった場合。SOAPException
- この SOAPElement に対して encodingStyle の設定が無効な場合。getEncodingStyle()
StringSE getEncodingStyle()
SOAPElement
オブジェクトのエンコードスタイルを返します。String
setEncodingStyle(java.lang.String)
Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.