SOAPElement (Java Platform SE 8 )

All Superinterfaces:

Element， Node

All Known Subinterfaces:

Detail， DetailEntry， SOAPBody， SOAPBodyElement， SOAPEnvelope， SOAPFault， SOAPFaultElement， SOAPHeader， SOAPHeaderElement
```
public interface SOAPElement
extends Node, Element
```
表示允许但不由肥皂规范指定的元素的一个对象的对象。此接口为这些对象的基本接口，这些对象是由一个由肥皂规范规定的对象提供的。
在这个界面，需要返回用于特定对象可能“默默地”代替树中的节点按要求顺利回到正确类型的对象的方法。看到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`	`addNamespaceDeclaration(String prefix, String uri)` 添加一个具有指定的前缀和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()` 返回所有在这 `SOAPElement`属性 `QName`对象 `Iterator`。
`String`	`getAttributeValue(Name name)` 用指定名称返回属性的值。
`String`	`getAttributeValue(QName qname)` 返回与指定的属性的属性值。
`Iterator`	`getChildElements()` 返回所有该元素的直接子 `Node`s一 `Iterator`。
`Iterator`	`getChildElements(Name name)` 所有的孩子 `Node`s立即返回该元素具有指定名称的 `Iterator`。
`Iterator`	`getChildElements(QName qname)` 返回所有直接子 `Node`s这个元素指定一个 `Iterator` QName。
`Name`	`getElementName()` 返回该 `SOAPElement`对象的名称。
`QName`	`getElementQName()` 返回该对象的属性 `SOAPElement`。
`String`	`getEncodingStyle()` 返回此 `SOAPElement`对象的编码风格。
`Iterator`	`getNamespacePrefixes()` 返回在命名空间前缀 `String`s宣布由该元素的 `Iterator`。
`String`	`getNamespaceURI(String prefix)` 返回的URI命名空间具有特定的前缀。
`Iterator`	`getVisibleNamespacePrefixes()` 返回在命名空间前缀 `String`s这个元素可见 `Iterator`。
`boolean`	`removeAttribute(Name name)` 用指定名称删除属性。
`boolean`	`removeAttribute(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对象。
    这种方法可能在未来的释放有利于addchildelement SAAJ弃用（javax. XML命名空间。12）
    
    参数
    
    name - Name对象与XML名称为新的元素
    
    结果
    
    新 SOAPElement创建对象
    
    异常
    
    SOAPException -如果在创建 SOAPElement对象错误
    
    另请参见：
    
    addChildElement(javax.xml.namespace.QName)
  - addChildElement
```
SOAPElement addChildElement(QName qname)
                     throws SOAPException
```
    创建一个新的 SOAPElement对象与给定的 QName对象初始化和添加新的元素到这个 SOAPElement对象。的命名空间，LocalName和新 SOAPElement前缀都从 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 --如果在这 SOAPElement上下文或如果在创建 SOAPElement对象错误的 prefix无效
  - addChildElement
```
SOAPElement addChildElement(String localName,
                            String prefix,
                            String uri)
                     throws SOAPException
```
    创建一个新的 SOAPElement对象具有指定的本地名称，初始化的前缀和URI和添加新的元素到这个 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不能包含元素命名为“信封”，“头”和“身体”在SOAP命名空间。任何片段中的命名空间前缀应该完全解决使用适当的命名空间声明内的片段本身。
    
    参数
    
    element - SOAPElement被添加作为一个新的孩子
    
    结果
    
    表示实际上添加到树的新的元素的实例。
    
    异常
    
    SOAPException -如果加入这种元素作为一个孩子，有一个错误
  - removeContents
```
void removeContents()
```
    将所有的孩子这 SOAPElement。
    此方法用于回滚部分完成SOAPHeaders和SOAPBodys施工准备发送故障时检测到错误条件。它也可用于在一个肥皂消息中回收文档的一部分。
    
    从以下版本开始：
    
    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 -如果在创建属性错误，或是与 Name name在此SOAPElement属性设置无效。
    
    另请参见：
    
    addAttribute(javax.xml.namespace.QName, String)
  - addAttribute
```
SOAPElement addAttribute(QName qname,
                         String value)
                  throws SOAPException
```
    将具有指定名称和值的属性这一 SOAPElement对象。
    
    参数
    
    qname --一个具有该属性的名称 QName对象
    
    value - String给该属性的值
    
    结果
    
    的 SOAPElement对象的属性插入
    
    异常
    
    SOAPException -如果在创建属性错误，或是设置一个属性，这 QName qname SOAPElement无效。
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    addAttribute(Name, String)
  - addNamespaceDeclaration
```
SOAPElement addNamespaceDeclaration(String prefix,
                                    String uri)
                             throws SOAPException
```
    添加一个具有指定的前缀和URI，这 SOAPElement对象命名空间声明。
    
    参数
    
    prefix - String给命名空间的前缀
    
    uri - String给命名空间的URI
    
    结果
    
    的 SOAPElement对象为该命名空间声明插入。
    
    异常
    
    SOAPException -如果在创建命名空间的一个错误
  - getAttributeValue
```
String getAttributeValue(Name name)
```
    用指定名称返回属性的值。
    
    参数
    
    name --一个具有该属性的名称 Name对象
    
    结果
    
    一个 String给指定的属性值，null，如果没有这样的属性
    
    另请参见：
    
    getAttributeValue(javax.xml.namespace.QName)
  - getAttributeValue
```
String getAttributeValue(QName qname)
```
    返回与指定的属性的属性值。
    
    参数
    
    qname --一个具有该属性的属性 QName对象
    
    结果
    
    一个 String给指定的属性值，null，如果没有这样的属性
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    getAttributeValue(Name)
  - getAllAttributes
```
Iterator getAllAttributes()
```
    返回一个 Iterator所有的属性 Name对象在这 SOAPElement对象。迭代器可以用来获取属性名称，然后可以通过该方法 getAttributeValue检索每个属性的值。
    
    结果
    
    属性名称的迭代器
    
    另请参见：
    
    getAllAttributesAsQNames()
  - getAllAttributesAsQNames
```
Iterator getAllAttributesAsQNames()
```
    返回所有在这 SOAPElement属性 QName对象 Iterator。迭代器可以用来获取属性的属性，然后可以通过该方法 getAttributeValue检索每个属性的值。
    
    结果
    
    在属性的限定名迭代器
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    getAllAttributes()
  - getNamespaceURI
```
String getNamespaceURI(String prefix)
```
    返回的URI命名空间具有特定的前缀。
    
    参数
    
    prefix - String给予该命名空间的前缀搜索
    
    结果
    
    一个 String的URI命名空间的具有特定的前缀
  - getNamespacePrefixes
```
Iterator getNamespacePrefixes()
```
    返回命名空间前缀的 Iterator Strings由该元素声明。前缀返回这个迭代器可以传递给方法 getNamespaceURI检索每个命名空间的URI。
    
    结果
    
    在这 SOAPElement对象的命名空间前缀的迭代器
  - getVisibleNamespacePrefixes
```
Iterator getVisibleNamespacePrefixes()
```
    返回在命名空间前缀的 Iterator Strings这个元素可见。前缀返回这个迭代器可以传递给方法 getNamespaceURI检索每个命名空间的URI。
    
    结果
    
    在命名空间前缀的迭代器都在这 SOAPElement对象范围
    
    从以下版本开始：
    
    SAAJ 1.2
  - createQName
```
QName createQName(String localName,
                  String prefix)
           throws SOAPException
```
    创建一个 QName的命名空间URI是一个参数， prefix有关，在这 SOAPElement语境。新的 QName其余元素均采取直接从参数， localName和 prefix。
    
    参数
    
    localName - String包含名称的本地部分。
    
    prefix - String包含名称的前缀。
    
    结果
    
    以指定的 localName和 prefix QName，和命名空间是在这 SOAPElement语境 prefix有关。这个命名空间将作为一个将返回 getNamespaceURI(String)要是给 prefix作为它的参数相同。
    
    异常
    
    SOAPException -如果 QName不能创造。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getElementName
```
Name getElementName()
```
    返回该 SOAPElement对象的名称。
    
    结果
    
    这与 SOAPElement对象的名称 Name对象
  - getElementQName
```
QName getElementQName()
```
    返回该对象的属性 SOAPElement。
    
    结果
    
    这与 SOAPElement对象将 QName对象
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    getElementName()
  - setElementQName
```
SOAPElement setElementQName(QName newName)
                     throws SOAPException
```
    改变这 Element名称 newName如果可能的话。SOAP定义的元素如soapenvelope、SOAPHeader、配糖体等不能有自己的名字，用这种方法改变了。任何试图这样做将导致一个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对象的属性将被删除
    
    结果
    
    true如果属性被成功取出； false如果不是
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    removeAttribute(Name)
  - removeNamespaceDeclaration
```
boolean removeNamespaceDeclaration(String prefix)
```
    移除与给定前缀对应的命名空间声明。
    
    参数
    
    prefix - String给其前缀搜索
    
    结果
    
    true如果命名空间声明已成功删除； false如果不是
  - getChildElements
```
Iterator getChildElements()
```
    返回所有该元素的直接子 Nodes一 Iterator。这包括 javax.xml.soap.Text对象以及 SOAPElement对象。
    调用此方法，可以使孩子Element，SOAPElement和org.w3c.dom.Text节点被SOAPElement，SOAPHeaderElement取代，SOAPBodyElement或javax.xml.soap.Text节点适合该父节点的类型。作为一个结果，调用应用程序必须处理任何现有的这些参考节点已通过DOM接口无效，要么丢弃或刷新他们的Iterator返回值。这种行为可以通过调用DOM API避免等效。看到javax.xml.soap for more details.
    
    结果
    
    随着这 SOAPElement对象内容的迭代器
  - getChildElements
```
Iterator getChildElements(Name name)
```
    所有的孩子 Nodes立即返回该元素具有指定名称的 Iterator。这些孩子将 SOAPElement节点。
    调用此方法，可以使孩子Element，SOAPElement和org.w3c.dom.Text节点被SOAPElement，SOAPHeaderElement取代，SOAPBodyElement或javax.xml.soap.Text节点适合该父节点的类型。作为一个结果，调用应用程序必须处理任何现有的这些参考节点已通过DOM接口无效，要么丢弃或刷新他们的价值观的Iterator返回。这种行为可以通过调用DOM API避免等效。看到javax.xml.soap for more details.
    
    参数
    
    name - Name对象的子元素的名称将返回
    
    结果
    
    在所有的元素在这 SOAPElement对象使用指定名称的 Iterator对象
    
    另请参见：
    
    getChildElements(javax.xml.namespace.QName)
  - getChildElements
```
Iterator getChildElements(QName qname)
```
    返回所有直接子 Nodes这个元素指定一个 Iterator QName。这些孩子将 SOAPElement节点。
    调用此方法，可以使孩子Element，SOAPElement和org.w3c.dom.Text节点被SOAPElement，SOAPHeaderElement取代，SOAPBodyElement或javax.xml.soap.Text节点适合该父节点的类型。作为一个结果，调用应用程序必须处理任何现有的这些参考节点已通过DOM接口无效，要么丢弃或刷新他们的Iterator返回值。这种行为可以通过调用DOM API避免等效。看到javax.xml.soap for more details.
    
    参数
    
    qname - QName对象的子元素将被退回
    
    结果
    
    在所有的元素在这 SOAPElement对象的指定属性的 Iterator对象
    
    从以下版本开始：
    
    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)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface SOAPElement

Field Summary

Fields inherited from interface org.w3c.dom.Node

方法摘要

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Element

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