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) 創建一個 QName，其名稱空間 URI 應與此 SOAPElement 上下文中的參數、prefix 相關聯。
Iterator	getAllAttributes() 返回可在此 SOAPElement 物件中所有屬性 Name 物件上進行迭代的 Iterator。
Iterator	getAllAttributesAsQNames() 返回可在此 SOAPElement 物件（以 QName 物件的形式）中的所有屬性上進行迭代的 Iterator。
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 物件。

此方法在以後的 SAAJ 版本中可能會被廢棄，並用 addChildElement(javax.xml.namespace.QName) 取代。

參數：

name - Name 物件，帶有新元素的 XML 名稱

返回：

創建的新 SOAPElement 物件

拋出：

SOAPException - 如果在創建 SOAPElement 物件時發生錯誤

另請參見：

addChildElement(javax.xml.namespace.QName)

addChildElement

SOAPElement addChildElement(QName qname)
                            throws SOAPException

創建使用給定 QName 物件初始化的新 SOAPElement 物件，並將該新元素添加到此 SOAPElement 物件。新 SOAPElement 的 namespace、localname 和 prefix 都取自 qname 參數。

參數：

qname - QName 物件，帶有新元素的 XML 名稱

返回：

創建的新 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 實例的子級添加。應該由 SOAPFactory 來創建 SOAPElement。調用者不應依靠此方式添加到 XML 階層樹的元素實例。實作最後可以將傳遞的 SOAPElement 的內容複製到一個不同 SOAPElement 實作的實例中。例如，如果對 SOAPHeader 調用 addChildElement()，則 element 將被複製到 SOAPHeaderElement 的實例中。

以 element 為根的片段將作為一個整體添加，如果發生錯誤，則不添加。

以 element 為根的片段不能包含名為 "Envelope"、"Header" 或 "Body" 且屬於 SOAP 名稱空間的元素。片段中出現的任何名稱空間前綴都應該使用片段本身中適當的名稱空間宣告來完整解析。

參數：

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 - 如果在創建屬性時發生錯誤，或者在此 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 - 如果在創建屬性時出現錯誤，如果在此 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 物件（以 QName 物件的形式）中的所有屬性上進行迭代的 Iterator。迭代器可以用於獲取屬性 QName，然後可將這些名稱傳遞給方法 getAttributeValue 以檢索每個屬性的值。

返回：

在屬性的 QNames 上進行迭代的迭代器

從以下版本開始：

SAAJ 1.3

另請參見：

getAllAttributes()

getNamespaceURI

String getNamespaceURI(String prefix)

返回帶有給定前綴的名稱空間的 URI。

參數：

prefix - 一個 String，給出用來搜尋的名稱空間前綴

返回：

一個 String，帶有給定前綴名稱空間的 URI

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

創建一個 QName，其名稱空間 URI 應與此 SOAPElement 上下文中的參數、prefix 相關聯。新 QName 的其餘元素都直接取自參數、localName 和 prefix。

參數：

localName - 套件含名稱本地部分的 String。

prefix - 套件含名稱前綴的 String。

返回：

一個 QName，帶有指定的 localName 和 prefix，以及與此 SOAPElement 上下文中的 prefix 關聯的名稱空間。如果將 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。SOAP 定義的元素，如 SOAPEnvelope、SOAPHeader、SOAPBody 等，都無法使用此方法更改它們的名稱。任何此類別嘗試都會導致拋出 SOAPException。

調用者不應依靠按此方式重命名的元素實例。實作最後可以將 SOAPElement 的內容複製到重命名實例。

參數：

newName - Element 的新名稱。

返回：

重命名的節點

拋出：

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。這包括 javax.xml.soap.Text 物件以及 SOAPElement 物件。

調用此方法可能導致子 Element、SOAPElement 和 org.w3c.dom.Text 節點被適合於此父節點型別的 SOAPElement、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 和 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 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 物件

從以下版本開始：

SAAJ 1.3

另請參見：

getChildElements(Name)

setEncodingStyle

void setEncodingStyle(String encodingStyle)
                      throws SOAPException

將此 SOAPElement 物件的編碼樣式設置為指定樣式。

參數：

encodingStyle - 給出編碼樣式的 String

拋出：

IllegalArgumentException - 如果在設置編碼樣式時出現問題。

SOAPException - 如果為此 SOAPElement 設置的編碼樣式無效。

另請參見：

getEncodingStyle()

getEncodingStyle

String getEncodingStyle()

返回此 SOAPElement 物件的編碼樣式。

返回：

給出編碼樣式的 String

另請參見：

setEncodingStyle(java.lang.String)