All Superinterfaces:

Element ， Node ， 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 。

从以下版本开始：

1.6

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	方法	描述
`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)`	创建一个新的 `SOAPElement`对象，使用指定的本地名称，前缀和URI初始化，并将新元素添加到此 `SOAPElement`对象。
`SOAPElement`	`addChildElement(QName qname)`	创建使用给定的 `SOAPElement`对象初始化的新的 `QName`对象，并将新元素添加到此 `SOAPElement`对象。
`SOAPElement`	`addChildElement(Name name)`	创建使用给定的 `SOAPElement`对象初始化的新的 `Name`对象，并将新元素添加到此 `SOAPElement`对象。
`SOAPElement`	`addChildElement(SOAPElement element)`	添加一个 `SOAPElement`作为这个 `SOAPElement`实例的孩子。
`SOAPElement`	`addNamespaceDeclaration(String prefix, String uri)`	向此 `SOAPElement`对象添加一个具有指定前缀和URI的命名空间声明。
`SOAPElement`	`addTextNode(String text)`	创建一个新的 `Text`对象，使用给定的 `String`初始化并将其添加到此 `SOAPElement`对象。
`QName`	`createQName(String localName, String prefix)`	在这个 `SOAPElement`的上下文中创建一个 `QName`其名称空间URI是与参数 `prefix`相关联的URI。
`Iterator<Name>`	`getAllAttributes()`	在该 `SOAPElement`对象中的所有属性 `Name`对象中返回一个 `Iterator` 。
`Iterator<QName>`	`getAllAttributesAsQNames()`	返回一个 `Iterator`对所有在这个属性的 `SOAPElement`为 `QName`的对象。
`String`	`getAttributeValue(QName qname)`	返回具有指定qname的属性值。
`String`	`getAttributeValue(Name name)`	返回具有指定名称的属性值。
`Iterator<Node>`	`getChildElements()`	返回一个`Iterator`了所有直接子`Node` s此元素。
`Iterator<Node>`	`getChildElements(QName qname)`	返回一个`Iterator`的所有直接的孩子`Node` s这个元素与指定的qname。
`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()`	返回一个 `Iterator` ，该名称空间前缀 `String`对此元素可见。
`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`对象的编码样式设置为一个指定。

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 javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

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对象时出错
    
    从以下版本开始：
    
    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或创建 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将element复制到SOAPHeaderElement一个实例中。
    如果出现错误，则根据根本原因， element的片段是全部添加或根本不添加。
    
    基于element的片段不能包含名为“Envelope”，“Header”或“Body”的元素和SOAP命名空间中的元素。片段中存在的任何命名空间前缀应使用片段本身中适当的命名空间声明进行完全解析。
    
    参数
    
    element - 要添加为新的孩子的 SOAPElement
    
    结果
    
    表示实际添加到树中的新SOAP元素的实例。
    
    异常
    
    SOAPException - 如果在将此元素添加为子代时出现错误
  - removeContents
```
void removeContents()
```
    分离这个SOAPElement所有孩子。
    该方法对于回滚部分完成的SOAPHeaders和SOAPBodys的构造有用，以准备在检测到错误条件时发送故障。它也可用于在SOAP消息中回收文档的部分。
    
    从以下版本开始：
    
    1.6，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对象
    
    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无效。
    
    从以下版本开始：
    
    1.6，SAAJ 1.3
    
    另请参见：
    
    addAttribute(Name, String)
  - addNamespaceDeclaration
```
SOAPElement addNamespaceDeclaration(String prefix,
                                    String uri)
                             throws SOAPException
```
    向此 SOAPElement对象添加具有指定前缀和URI的命名空间声明。
    
    参数
    
    prefix - 一个 String给出命名空间的前缀
    
    uri - 一个 String给出命名空间的uri
    
    结果
    
    该名称空间声明被插入的 SOAPElement对象。
    
    异常
    
    SOAPException - 创建命名空间是否有错误
  - getAttributeValue
```
String getAttributeValue(Name name)
```
    返回具有指定名称的属性值。
    
    参数
    
    name - 具有属性名称的 Name对象
    
    结果
    
    一个 String给出指定属性的值，如果没有这样的属性，则为空
    
    另请参见：
    
    getAttributeValue(javax.xml.namespace.QName)
  - getAttributeValue
```
String getAttributeValue(QName qname)
```
    返回具有指定qname的属性值。
    
    参数
    
    qname - 具有该属性的qname的 QName对象
    
    结果
    
    一个 String给出指定属性的值，如果没有这样的属性，则为空
    
    从以下版本开始：
    
    1.6，SAAJ 1.3
    
    另请参见：
    
    getAttributeValue(Name)
  - getAllAttributes
```
Iterator<Name> getAllAttributes()
```
    返回一个Iterator在所有的属性Name对象在此SOAPElement对象。迭代器可用于获取属性名称，然后可以将其传递给方法getAttributeValue以检索每个属性的值。
    
    结果
    
    对属性的名称进行迭代
    
    另请参见：
    
    getAllAttributesAsQNames()
  - getAllAttributesAsQNames
```
Iterator<QName> getAllAttributesAsQNames()
```
    返回一个Iterator对所有在这个属性的SOAPElement为QName的对象。迭代器可用于获取属性QName，然后可以将其传递给方法getAttributeValue以检索每个属性的值。
    
    结果
    
    在属性的QNames上的迭代器
    
    从以下版本开始：
    
    1.6，SAAJ 1.3
    
    另请参见：
    
    getAllAttributes()
  - getNamespaceURI
```
String getNamespaceURI(String prefix)
```
    返回具有给定前缀的命名空间的URI。
    
    参数
    
    prefix - 一个 String给出要搜索的命名空间的前缀
    
    结果
    
    一个具有给定前缀的命名空间的uri的 String
  - getNamespacePrefixes
```
Iterator<String> getNamespacePrefixes()
```
    返回一个Iterator在命名空间前缀String此元素声明秒。该迭代器返回的前缀可以传递给方法getNamespaceURI以检索每个命名空间的URI。
    
    结果
    
    这个 SOAPElement对象中的命名空间前缀的迭代器
  - getVisibleNamespacePrefixes
```
Iterator<String> getVisibleNamespacePrefixes()
```
    返回一个Iterator ，该名称空间前缀String对此元素可见。该迭代器返回的前缀可以传递给方法getNamespaceURI以检索每个命名空间的URI。
    
    结果
    
    命名空间前缀的迭代器在这个 SOAPElement对象的范围内
    
    从以下版本开始：
    
    1.6，SAAJ 1.2
  - createQName
```
QName createQName(String localName,
                  String prefix)
           throws SOAPException
```
    在这个SOAPElement的上下文中创建一个QName其命名空间URI是与参数prefix相关联的URI。新的QName的其余元素直接来自参数localName和prefix 。
    
    参数
    
    localName - 一个包含本地部分名称的 String 。
    
    prefix - 一个包含名称前缀的 String 。
    
    结果
    
    一个QName具有指定localName和prefix ，并用与该相关联的命名空间prefix在此的上下文中SOAPElement 。这个命名空间将与getNamespaceURI(String)返回的命名空间相同，如果它是prefix作为参数。
    
    异常
    
    SOAPException - 如果无法创建 QName 。
    
    从以下版本开始：
    
    1.6，SAAJ 1.3
  - getElementName
```
Name getElementName()
```
    返回此 SOAPElement对象的名称。
    
    结果
    
    一个 Name对象，名称为 SOAPElement对象
  - getElementQName
```
QName getElementQName()
```
    返回此 SOAPElement对象的qname。
    
    结果
    
    一个 QName对象与这个 SOAPElement对象的qname
    
    从以下版本开始：
    
    1.6，SAAJ 1.3
    
    另请参见：
    
    getElementName()
  - setElementQName
```
SOAPElement setElementQName(QName newName)
                     throws SOAPException
```
    如果可能，将此Element的名称更改为newName 。 SOAP定义的元素（如SOAPEnvelope，SOAPHeader，SOAPBody等）不能使用此方法更改其名称。任何尝试这样做将导致抛出SOAPException。
    来电者不应该依赖于重命名的元素实例。实现可能SOAPElement的内容复制到重命名的实例。
    
    参数
    
    newName - 新名称为 Element 。
    
    结果
    
    重命名的节点
    
    异常
    
    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()
```
    返回该Iterator的所有直接子代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<Node> 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 。
    
    参数
    
    name - 一个 Name对象，其中要返回的子元素的名称
    
    结果
    
    一个 Iterator对象可在此所有元素 SOAPElement对象具有指定名称
    
    另请参见：
    
    getChildElements(javax.xml.namespace.QName)
  - getChildElements
```
Iterator<Node> getChildElements(QName qname)
```
    返回一个Iterator的所有直接子代Node这个元素与指定的qname。所有这些孩子将会有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
    
    结果
    
    一个 Iterator对象在该 SOAPElement对象中的所有元素与指定的qname
    
    从以下版本开始：
    
    1.6，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)

Interface SOAPElement

Field Summary

Fields inherited from interface org.w3c.dom.Node

方法摘要

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Node

方法详细信息

addChildElement

addChildElement

addChildElement

addChildElement

addChildElement

addChildElement

removeContents

addTextNode

addAttribute

addAttribute

addNamespaceDeclaration

getAttributeValue

getAttributeValue

getAllAttributes

getAllAttributesAsQNames

getNamespaceURI

getNamespacePrefixes

getVisibleNamespacePrefixes

createQName

getElementName

getElementQName

setElementQName

removeAttribute

removeAttribute

removeNamespaceDeclaration

getChildElements

getChildElements

getChildElements

setEncodingStyle

getEncodingStyle