public interface SOAPElement extends Node, Element
SAAJ固有のオブジェクトを返す必要のあるこのインタフェースのメソッドは、正しい型のオブジェクトを正常に返す必要があるため、ツリー内のノードを通知することなく置き換えます。詳細は、getChildElements()
およびjavax.xml.soapを参照してください。
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 オブジェクトのエンコーディング・スタイルを指定のものに設定します。 |
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
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)
SOAPElement addChildElement(QName qname) throws SOAPException
QName
オブジェクトで初期化したSOAPElement
オブジェクトを新しく作成し、その新規要素をこのSOAPElement
オブジェクトに追加します。新しいSOAPElement
の名前空間、ローカル名、および接頭辞は、すべてqname
引数から取得します。qname
- 新規要素のXML名を持つQName
オブジェクトSOAPElement
オブジェクトSOAPException
- SOAPElement
オブジェクトの作成時にエラーが発生した場合addChildElement(Name)
SOAPElement addChildElement(String localName) throws SOAPException
SOAPElement
オブジェクトを新しく作成し、その新規要素をこのSOAPElement
オブジェクトに追加します。新しいSOAPElement
は、デフォルトの名前空間の範囲をすべて継承しています。localName
- 要素のローカル名を示すString
SOAPElement
オブジェクトSOAPException
- SOAPElement
オブジェクトの作成時にエラーが発生した場合SOAPElement addChildElement(String localName, String prefix) throws SOAPException
SOAPElement
オブジェクトを新しく作成し、その新規要素をこのSOAPElement
オブジェクトに追加します。localName
- 新規要素のローカル名を示すString
prefix
- 新規要素の名前空間の接頭辞を示すString
SOAPElement
オブジェクトSOAPException
- prefix
がこのSOAPElement
のコンテキストで有効でない場合、またはSOAPElement
オブジェクトの作成でエラーが発生した場合SOAPElement addChildElement(String localName, String prefix, String 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
にルートされたフラグメントは全体として追加されます。ただし、エラーが発生した場合は1つも追加されません。
element
にルートされたフラグメントには、SOAP名前空間に「Envelope」、「Header」、「Body」という名前の要素を保有できません。フラグメントに存在する名前空間の接頭辞は、そのフラグメント内部で適切な名前空間宣言を使用して完全に解決される必要があります。
element
- 新しい子として追加されるSOAPElement
SOAPException
- この要素を子として追加するときにエラーが発生した場合void removeContents()
SOAPElement
のすべての子を切り離します。
このメソッドは、エラー状態の検出時に障害を送信する準備として、SOAPHeaders
やSOAPBodys
を構築が完成している部分までロールバックするのに役立ちます。また、SOAPメッセージ内のドキュメントの一部の再利用にも役立ちます。
SOAPElement addTextNode(String text) throws SOAPException
String
で初期化されたText
オブジェクトを新しく作成し、このSOAPElement
オブジェクトに追加します。text
- 追加するテキスト・コンテンツを持つString
オブジェクトText
オブジェクトが挿入されたSOAPElement
オブジェクトSOAPException
- 新しいText
オブジェクトの作成でエラーが発生した場合、またはこのSOAPElement
に子として添付することが許可されていない場合SOAPElement addAttribute(Name name, String value) throws SOAPException
SOAPElement
オブジェクトに追加します。name
- 属性名を持つName
オブジェクトvalue
- 属性値を提供するString
SOAPElement
オブジェクトSOAPException
- 属性の作成でエラーが発生した場合、またはName
name
を持つ属性をこのSOAPElementに設定することが無効な場合。addAttribute(javax.xml.namespace.QName, String)
SOAPElement addAttribute(QName qname, String value) throws SOAPException
SOAPElement
オブジェクトに追加します。qname
- 属性名を持つQName
オブジェクトvalue
- 属性値を提供するString
SOAPElement
オブジェクトSOAPException
- 属性の作成でエラーが発生した場合、またはQName
qname
を持つ属性をこのSOAPElementに設定することが無効な場合。addAttribute(Name, String)
SOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException
SOAPElement
オブジェクトに追加します。prefix
- 名前空間の接頭辞を指定するString
uri
- 名前空間のURIを指定するString
SOAPElement
オブジェクト。SOAPException
- 名前空間の作成でエラーが発生した場合String getAttributeValue(Name name)
name
- 属性名を持つName
オブジェクトString
、またはそのような属性がない場合はNullgetAttributeValue(javax.xml.namespace.QName)
String getAttributeValue(QName qname)
qname
- 属性のqnameを持つQName
オブジェクトString
、またはそのような属性がない場合はNullgetAttributeValue(Name)
Iterator getAllAttributes()
SOAPElement
オブジェクト内のすべての属性Name
オブジェクトについてのIterator
を返します。イテレータは属性名の取得に使用し、getAttributeValue
メソッドへ渡して各属性の値を取得できます。getAllAttributesAsQNames()
Iterator getAllAttributesAsQNames()
SOAPElement
内のすべての属性についてのIterator
をQName
オブジェクトとして返します。イテレータは属性QNameの取得に使用し、getAttributeValue
メソッドへ渡して各属性の値を取得できます。getAllAttributes()
String getNamespaceURI(String prefix)
prefix
- 検索する名前空間の接頭辞を指定するString
String
Iterator getNamespacePrefixes()
String
のIterator
を返します。このイテレータで返された接頭辞をgetNamespaceURI
メソッドに渡し、各名前空間のURIを取得できます。SOAPElement
オブジェクトの名前空間接頭辞のイテレータIterator getVisibleNamespacePrefixes()
String
のIterator
を返します。このイテレータで返された接頭辞をgetNamespaceURI
メソッドに渡し、各名前空間のURIを取得できます。SOAPElement
オブジェクトのスコープ内にある名前空間接頭辞のイテレータQName createQName(String localName, String prefix) throws SOAPException
SOAPElement
のコンテキストのパラメータprefix
に関連しているQName
を作成します。新しいQName
の残りの要素は、パラメータ、localName
、およびprefix
から直接取得します。localName
- 名前のローカル部分を含むString
。prefix
- 名前の接頭辞を含むString
。localName
とprefix
、およびこのSOAPElement
のコンテキストのprefix
に関連した名前空間を持つQName
。この名前空間は、getNamespaceURI(String)
にパラメータとしてprefix
を指定した場合に返されるものと同一である。SOAPException
- QName
を作成できない場合。Name getElementName()
SOAPElement
オブジェクトの名前を返します。SOAPElement
オブジェクトの名前を持つName
オブジェクトQName getElementQName()
SOAPElement
オブジェクトのqnameを返します。SOAPElement
オブジェクトのqnameを持つQName
オブジェクトgetElementName()
SOAPElement setElementQName(QName newName) throws SOAPException
Element
の名前をnewName
に変更します。SOAPEnvelope、SOAPHeader、SOAPBodyなどのようなSOAP Defined要素は、このメソッドを使用して名前を変更できません。変更しようとすると、SOAPExceptionがスローされます。
呼出し側は、そのまま名前変更される要素インスタンスを信用してはいけません。SOAPElement
のコンテンツを、名前変更したインスタンスにコピーして実装が終わる可能性があります。
newName
- Element
の新しい名前。SOAPException
- このElement
の名前変更が許可されていない場合。boolean removeAttribute(Name name)
name
- 削除する属性の名前を持つName
オブジェクトtrue
、正常に削除されなかった場合はfalse
removeAttribute(javax.xml.namespace.QName)
boolean removeAttribute(QName qname)
qname
- 削除する属性のqnameを持つQName
オブジェクトtrue
、正常に削除されなかった場合はfalse
removeAttribute(Name)
boolean removeNamespaceDeclaration(String prefix)
prefix
- 検索する接頭辞を指定するString
true
、正常に削除されなかった場合はfalse
Iterator 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
オブジェクトのコンテンツを持つイテレータIterator 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)
Iterator getChildElements(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
オブジェクトSOAPElement
オブジェクトの要素すべてにわたるIterator
オブジェクトgetChildElements(Name)
void setEncodingStyle(String encodingStyle) throws SOAPException
SOAPElement
オブジェクトのエンコーディング・スタイルを指定のものに設定します。encodingStyle
- エンコーディング・スタイルを指定するString
IllegalArgumentException
- 設定するエンコーディング・スタイルに問題があった場合。SOAPException
- このSOAPElementに対するencodingStyleの設定が無効の場合。getEncodingStyle()
String getEncodingStyle()
SOAPElement
オブジェクトのエンコーディング・スタイルを返します。String
setEncodingStyle(java.lang.String)
バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.