javax.xml.soap

Interface SOAPElement

All Superinterfaces:

Element ， Node

All Known Subinterfaces:

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

public interface SOAPElement
extends Node, Element

表示SOAP消息的元素的对象，SOAP消息被允许但不是由SOAP规范特别规定。 该接口用作SOAP规范具体规定的那些对象的基本接口。

返回SAAJ特定对象所需的此接口中的方法可以根据需要“静默地”替换树中的节点，以成功返回正确类型的对象。 参见getChildElements()和javax.xml.soap for details.

Field Summary

Fields inherited from interface 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

方法摘要

Modifier and Type	Method and Description
SOAPElement	addAttribute(Name name, String value) 将具有指定名称和值的属性添加到此 SOAPElement对象。
SOAPElement	addAttribute(QName qname, String value) 将具有指定名称和值的属性添加到此 SOAPElement对象。
SOAPElement	addChildElement(Name name) 创建一个新的 SOAPElement对象，使用给定的 Name对象初始化，并将新元素添加到此 SOAPElement对象。
SOAPElement	addChildElement(QName qname) 创建一个新的 SOAPElement对象，使用给定的 QName对象初始化，并将新元素添加到此 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) 创建一个新的 SOAPElement对象，该对象使用指定的本地名称，前缀和URI SOAPElement ，并将新元素添加到此 SOAPElement对象。
SOAPElement	addNamespaceDeclaration(String prefix, String uri) 向此 SOAPElement对象添加具有指定前缀和URI的 SOAPElement 。
SOAPElement	addTextNode(String text) 创建一个新的 Text对象，使用给定的 String并将其添加到此 SOAPElement对象。
QName	createQName(String localName, String prefix) 创建 QName ，其命名空间URI是与参数，相关联的一个 prefix ，在此的上下文中 SOAPElement 。
Iterator	getAllAttributes() 返回一个 Iterator在所有的属性 Name对象在此 SOAPElement对象。
Iterator	getAllAttributesAsQNames() 返回此 Iterator所有属性的 SOAPElement作为 QName对象。
String	getAttributeValue(Name name) 返回具有指定名称的属性值。
String	getAttributeValue(QName qname) 返回具有指定qname的属性值。
Iterator	getChildElements() 返回一个Iterator了所有直接子Node s此元素。
Iterator	getChildElements(Name name) 返回一个Iterator了所有直接子Node s的指定名称的此元素。
Iterator	getChildElements(QName qname) 使用指定的Iterator返回该Iterator的所有直接子级Node的Iterator。
Name	getElementName() 返回此 SOAPElement对象的名称。
QName	getElementQName() 返回此 SOAPElement对象的qname。
String	getEncodingStyle() 返回此 SOAPElement对象的编码样式。
Iterator	getNamespacePrefixes() 返回一个 Iterator在命名空间前缀 String此元素声明秒。
String	getNamespaceURI(String prefix) 返回具有给定前缀的命名空间的URI。
Iterator	getVisibleNamespacePrefixes() 返回此 Iterator空间前缀 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对象的编码样式设置为一个指定的。

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element

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

Methods inherited from interface 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

创建一个新SOAPElement给定初始化的对象Name对象，并将该新元素添加到此SOAPElement对象。

在未来的SAAJ发行版中可能会弃用此方法，以支持addChildElement（javax.xml.namespace.QName）

参数

name - 具有新元素的XML名称的 Name对象

结果

创建的新的 SOAPElement对象

异常

SOAPException - 创建 SOAPElement对象是否有错误

另请参见：

addChildElement(javax.xml.namespace.QName)

addChildElement

SOAPElement addChildElement(QName qname)
                     throws SOAPException

创建一个新的SOAPElement对象，使用给定的QName对象初始化，并将新元素添加到此SOAPElement对象。 新的命名空间 ，和的localName 前缀 SOAPElement都取自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或创建 SOAPElement对象时出错

addChildElement

SOAPElement addChildElement(String localName,
                            String prefix,
                            String uri)
                     throws SOAPException

创建使用指定的本地名称，前缀和URI初始化的新的 SOAPElement对象，并将新元素添加到此 SOAPElement对象。

参数

localName - 一个 String给出新元素的本地名称

prefix - 一个 String给出新元素的命名空间前缀

uri - 一个 String给出新元素所属的命名空间的URI

结果

新创建的 SOAPElement对象

异常

SOAPException - 如果创建 SOAPElement对象时出错

addChildElement

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作为一个新的孩子

结果

表示实际添加到树中的新SOAP元素的实例。

异常

SOAPException - 如果在将此元素添加为子代时出现错误

removeContents

void removeContents()

分离这个SOAPElement所有孩子。

此方法是用于回滚的部分完成的结构有用SOAPHeaders和SOAPBodys在制备用于在检测到错误条件时发送的故障。 它也可用于在SOAP消息中回收文档的部分。

从以下版本开始：

SAAJ 1.2

addTextNode

SOAPElement addTextNode(String text)
                 throws SOAPException

创建一个新的 Text对象，使用给定的 String并将其添加到此 SOAPElement对象。

参数

text - 具有要添加的文本内容的 String对象

结果

所述 SOAPElement新到哪个对象 Text插入对象

异常

SOAPException -如果有一个错误在创建新 Text对象，如果它是不合法的，将其连接为一个孩子这个 SOAPElement

addAttribute

SOAPElement addAttribute(Name name,
                         String value)
                  throws SOAPException

将具有指定名称和值的属性添加到此 SOAPElement对象。

参数

name - 具有 Name名称的 Name对象

value - 一个 String给出属性的值

结果

SOAPElement属性的 SOAPElement对象

异常

SOAPException - 如果在创建属性时出现错误，或者在此SOAPElement上设置Name Name name无效。

另请参见：

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

addAttribute

SOAPElement addAttribute(QName qname,
                         String value)
                  throws SOAPException

将具有指定名称和值的属性添加到此 SOAPElement对象。

参数

qname - 具有 QName名称的 QName对象

value - 一个 String给出属性的值

结果

SOAPElement属性的 SOAPElement对象

异常

SOAPException - 如果在创建属性时出现错误，或者在此SOAPElement上设置QName QName qname无效。

从以下版本开始：

SAAJ 1.3

另请参见：

addAttribute(Name, String)

addNamespaceDeclaration

SOAPElement addNamespaceDeclaration(String prefix,
                                    String uri)
                             throws SOAPException

向此 SOAPElement对象添加具有指定前缀和URI的 SOAPElement 。

参数

prefix - 一个 String给出 String的前缀

uri - 一个 String给出 String的uri

结果

该 SOAPElement空间声明被插入的 SOAPElement对象。

异常

SOAPException - 创建命名空间是否有错误

getAttributeValue

String getAttributeValue(Name name)

返回具有指定名称的属性值。

参数

name - 具有 Name名称的 Name对象

结果

一个 String给出指定属性的值，如果没有这样的属性，则为空

另请参见：

getAttributeValue(javax.xml.namespace.QName)

getAttributeValue

String getAttributeValue(QName qname)

返回具有指定qname的属性值。

参数

qname - 一个 QName对象与该属性的qname

结果

一个 String给出指定属性的值，如果没有这样的属性，则为空

从以下版本开始：

SAAJ 1.3

另请参见：

getAttributeValue(Name)

getAllAttributes

Iterator getAllAttributes()

返回一个Iterator在所有的属性Name对象在此SOAPElement对象。 迭代器可以用于获取属性名称，然后可以将其传递给方法getAttributeValue以检索每个属性的值。

结果

对属性的名称进行迭代

另请参见：

getAllAttributesAsQNames()

getAllAttributesAsQNames

Iterator getAllAttributesAsQNames()

返回此Iterator的所有属性的SOAPElement作为QName对象。 迭代器可用于获取属性QName，然后可以将其传递给方法getAttributeValue以检索每个属性的值。

结果

在属性的QNames上的迭代器

从以下版本开始：

SAAJ 1.3

另请参见：

getAllAttributes()

getNamespaceURI

String getNamespaceURI(String prefix)

返回具有给定前缀的命名空间的URI。

参数

prefix - 一个 String给出要搜索的命名空间的前缀

结果

一个 String与具有给定前缀名称空间的URI

getNamespacePrefixes

Iterator getNamespacePrefixes()

返回一个Iterator在命名空间前缀String此元素声明秒。 该迭代器返回的前缀可以传递给方法getNamespaceURI以检索每个命名空间的URI。

结果

这个 SOAPElement对象中的命名空间前缀的迭代器

getVisibleNamespacePrefixes

Iterator getVisibleNamespacePrefixes()

返回一个Iterator在命名空间前缀String有形之到此元素。 该迭代器返回的前缀可以传递给方法getNamespaceURI以检索每个命名空间的URI。

结果

命名空间前缀的迭代器在这个 SOAPElement对象的范围内

从以下版本开始：

SAAJ 1.2

createQName

QName createQName(String localName,
                  String prefix)
           throws SOAPException

创建QName ，其命名空间URI是与参数，相关联的一个prefix ，在此的上下文中SOAPElement 。 新的QName的其余元素直接来自参数localName和prefix 。

参数

localName - 一个 String本地部分名称的String。

prefix - 一个 String名称前缀的 String 。

结果

一个QName具有指定localName和prefix ，并用与该相关联的命名空间prefix在此的上下文中SOAPElement 。 这个命名空间将是一样会被返回的一个getNamespaceURI(String) ，如果它被赋予prefix ，因为它的参数。

异常

SOAPException - 如果无法创建 QName 。

从以下版本开始：

SAAJ 1.3

getElementName

Name getElementName()

返回此 SOAPElement对象的名称。

结果

一个 Name对象与这个 SOAPElement对象的名称

getElementQName

QName getElementQName()

返回此 SOAPElement对象的qname。

结果

一个 QName对象与这个 SOAPElement对象的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的 QName对象

结果

true如果属性被成功删除; false如果不是

从以下版本开始：

SAAJ 1.3

另请参见：

removeAttribute(Name)

removeNamespaceDeclaration

boolean removeNamespaceDeclaration(String prefix)

删除与给定前缀相对应的命名空间声明。

参数

prefix - 一个 String给出要搜索的前缀

结果

true如果命名空间声明成功删除; false如果不是

getChildElements

Iterator getChildElements()

返回一个Iterator了所有直接子Node s此元素。 这包括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 for more details.

结果

一个与这个 SOAPElement对象的内容的迭代器

getChildElements

Iterator getChildElements(Name name)

返回一个Iterator的所有直接孩子Node s这个元素与指定的名称。 所有这些孩子将会有SOAPElement个节点。

调用此方法可能会导致儿童Element ， SOAPElement和org.w3c.dom.Text节点被替换为SOAPElement ， SOAPHeaderElement ， SOAPBodyElement或javax.xml.soap.Text节点作为适合这种父节点的类型。 因此，调用应用程序必须将通过DOM API获取的这些子节点的任何现有引用视为无效，并将其丢弃或使用此Iterator返回的值刷新它们。 可以通过调用相应的DOM API来避免此行为。 见javax.xml.soap for more details.

参数

name - 一个 Name对象，其中要返回的子元素的名称

结果

一个 Iterator对象在该 SOAPElement对象中具有指定名称的所有元素

另请参见：

getChildElements(javax.xml.namespace.QName)

getChildElements

Iterator getChildElements(QName qname)

使用指定的Iterator返回该Iterator的所有直接子级Node的Iterator。 所有这些孩子将会有SOAPElement个节点。

调用此方法可能会导致儿童Element ， SOAPElement和org.w3c.dom.Text节点被替换为SOAPElement ， SOAPHeaderElement ， SOAPBodyElement或javax.xml.soap.Text节点作为适合这种父节点的类型。 因此，调用应用程序必须将通过DOM API获取的这些子节点的任何现有引用视为无效，并将其丢弃或使用此Iterator返回的值刷新它们。 可以通过调用相应的DOM API来避免此行为。 见javax.xml.soap for more details.

参数

qname - 一个 QName对象，其中要返回的子元素的qname

结果

一个 Iterator对象在该 SOAPElement对象中的所有元素与指定的qname

从以下版本开始：

SAAJ 1.3

另请参见：

getChildElements(Name)

setEncodingStyle

void setEncodingStyle(String encodingStyle)
               throws SOAPException

将此 SOAPElement对象的编码样式设置为一个指定的。

参数

encodingStyle - 一个 String给出编码风格

异常

IllegalArgumentException - 如果设置编码风格有问题。

SOAPException - 如果设置encodingStyle对此SOAPElement无效。

另请参见：

getEncodingStyle()

getEncodingStyle

String getEncodingStyle()

返回此 SOAPElement对象的编码样式。

结果

一个 String给出编码风格

另请参见：

setEncodingStyle(java.lang.String)