public interface SOAPElement extends Node, Element
SOAPBody object, the contents in a SOAPHeader
object, the content that can follow the SOAPBody object in a
SOAPEnvelope object, or what can follow the detail element
in a SOAPFault object. It is
the base class for all of the classes that represent the SOAP objects as
defined in the SOAP specification.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)
Adds an attribute with the specified name and value to this
SOAPElement object. |
SOAPElement |
addChildElement(Name name)
Creates a new
SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(SOAPElement element)
Add a
SOAPElement as a child of this
SOAPElement instance. |
SOAPElement |
addChildElement(String localName)
Creates a new
SOAPElement object initialized with the
given String object and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(String localName,
String prefix)
Creates a new
SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(String localName,
String prefix,
String uri)
Creates a new
SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object. |
SOAPElement |
addNamespaceDeclaration(String prefix,
String uri)
Adds a namespace declaration with the specified prefix and URI to this
SOAPElement object. |
SOAPElement |
addTextNode(String text)
Creates a new
Text object initialized with the given
String and adds it to this SOAPElement object. |
Iterator<Name> |
getAllAttributes()
Returns an iterator over all of the attribute names in
this
SOAPElement object. |
String |
getAttributeValue(Name name)
Returns the value of the attribute with the specified
name.
|
Iterator |
getChildElements()
Returns an iterator over all the immediate content of
this element.
|
Iterator |
getChildElements(Name name)
Returns an iterator over all the child elements with the
specified name.
|
Name |
getElementName()
Returns the name of this
SOAPElement
object. |
String |
getEncodingStyle()
Returns the encoding style for this
SOAPElement object. |
Iterator |
getNamespacePrefixes()
Returns an iterator of namespace prefixes.
|
String |
getNamespaceURI(String prefix)
Returns the URI of the namespace that has the given
prefix.
|
Iterator |
getVisibleNamespacePrefixes()
Returns an
Iterator over the namespace prefix
Strings visible to this element. |
boolean |
removeAttribute(Name name)
Removes the attribute with the specified name.
|
void |
removeContents()
Detaches all children of this
SOAPElement. |
boolean |
removeNamespaceDeclaration(String prefix)
Removes the namespace declaration corresponding to the
given prefix.
|
void |
setEncodingStyle(String encodingStyle)
Sets the encoding style for this
SOAPElement
object to one specified. |
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValuegetAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNSappendChild, 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, setUserDataSOAPElement addChildElement(Name name) throws SOAPException
SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object.name - a Name object with the XML name for the
new elementSOAPElement object that was createdSOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(String localName) throws SOAPException
SOAPElement object initialized with the
given String object and adds the new element to this
SOAPElement object.localName - a String giving the local name for
the elementSOAPElement object that was createdSOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(String localName, String prefix) throws SOAPException
SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object.localName - a String giving the local name for
the new elementprefix - a String giving the namespace prefix for
the new elementSOAPElement object that was createdSOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException
SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object.localName - a String giving the local name for
the new elementprefix - a String giving the namespace prefix for
the new elementuri - a String giving the URI of the namespace
to which the new element belongsSOAPElement object that was createdSOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(SOAPElement element) throws SOAPException
SOAPElement as a child of this
SOAPElement instance. The SOAPElement
is expected to be created by a
SOAPElementFactory. Callers should not rely on the
element instance being added as is into the XML
tree. Implementations could end up copying the content
of the SOAPElement passed into an instance of
a different SOAPElement implementation. For
instance if addChildElement() is called on a
SOAPHeader, element will be copied
into an instance of a SOAPHeaderElement.
The fragment rooted in element is either added
as a whole or not at all, if there was an error.
The fragment rooted in element cannot contain
elements named "Envelope", "Header" or "Body" and in the SOAP
namespace. Any namespace prefixes present in the fragment
should be fully resolved using appropriate namespace
declarations within the fragment itself.
element - the SOAPElement to be added as a
new childSOAPException - if there was an error in adding this
element as a childSOAPElement addTextNode(String text) throws SOAPException
Text object initialized with the given
String and adds it to this SOAPElement object.text - a String object with the textual content to be addedSOAPElement object into which
the new Text object was insertedSOAPException - if there is an error in creating the
new Text objectSOAPElement addAttribute(Name name, String value) throws SOAPException
SOAPElement object.
name - a Name object with the name of the attributevalue - a String giving the value of the attributeSOAPElement object into which the attribute was
insertedSOAPException - if there is an error in creating the
AttributeSOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException
SOAPElement object.
prefix - a String giving the prefix of the namespaceuri - a String giving
the prefix of the namespaceSOAPElement object into which this
namespace declaration was inserted.SOAPException - if there is an error in creating the
namespaceString getAttributeValue(Name name)
name - a Name object with
the name of the attributeString giving the value of the
specified attributeIterator<Name> getAllAttributes()
SOAPElement object. The iterator can be
used to get the attribute names, which can then be passed to
the method getAttributeValue to retrieve the
value of each attribute.String getNamespaceURI(String prefix)
prefix - a String giving
the prefix of the namespace for which to searchString with the uri of the namespace
that has the given prefixIterator getNamespacePrefixes()
getNamespaceURI to retrieve
the URI of each namespace.SOAPElement objectName getElementName()
SOAPElement
object.Name object with the name of this
SOAPElement objectboolean removeAttribute(Name name)
name - the Name object with
the name of the attribute to be removedtrue if the attribute was removed
successfully; false if it was notboolean removeNamespaceDeclaration(String prefix)
prefix - a String giving
the prefix for which to searchtrue if the namespace declaration was
removed successfully; false if it was
notIterator getChildElements()
Text objects as well
as SOAPElement objects.SOAPElement objectIterator getChildElements(Name name)
name - a Name object with
the name of the child elements to be returnedIterator object over all the elements
in this SOAPElement object with the
specified namevoid setEncodingStyle(String encodingStyle) throws SOAPException
SOAPElement
object to one specified.encodingStyle - a String
giving the encoding styleIllegalArgumentException - if
there was a problem in the encoding style being set.SOAPExceptiongetEncodingStyle()String getEncodingStyle()
SOAPElement object.String giving the encoding stylesetEncodingStyle(java.lang.String)void removeContents()
SOAPElement.
This method is useful for rolling back the construction of partially
completed SOAPHeaders and SOAPBodys in
reparation for sending a fault when an error condition is detected. It is
also useful for recycling portions of a document within a SOAP message.
Iterator getVisibleNamespacePrefixes()
Iterator over the namespace prefix
Strings visible to this element. The prefixes returned by
this iterator can be passed to the method getNamespaceURI()
to retrieve the URI of each namespace.SOAPElement object