SOAPElement JDK 1.6)

public SOAPElement addAttribute (Name name, String value) throws SOAPException

Adds an attribute with the specified name and value to this SOAPElement object.

Adds an attribute with the specified name and value to this
SOAPElement object.
Returns: the SOAPElement object into which the attribute was inserted
Parameters:
- name - a Name object with the name of the attribute
- value - a String giving the value of the attribute
Throws:
- SOAPException - if there is an error in creating the Attribute, or it is invalid to set an attribute with Name name on this SOAPElement.
See Also: SOAPElement.addAttribute(javax.xml.namespace.QName, String),

public SOAPElement addAttribute (QName qname, String value) throws SOAPException

Adds an attribute with the specified name and value to this SOAPElement object.

Adds an attribute with the specified name and value to this
SOAPElement object.
Returns: the SOAPElement object into which the attribute was inserted
Parameters:
- qname - a QName object with the name of the attribute
- value - a String giving the value of the attribute
Throws:
- SOAPException - if there is an error in creating the Attribute, or it is invalid to set an attribute with QName qname on this SOAPElement.
Since: SAAJ 1.3
See Also: SOAPElement.addAttribute(Name, String),

public SOAPElement addChildElement (Name name) throws SOAPException

Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.

This method may be deprecated in a future release of SAAJ in favor of addChildElement(javax.xml.namespace.QName)
Returns: the new SOAPElement object that was created
Parameters:
- name - a Name object with the XML name for the new element
Throws:
- SOAPException - if there is an error in creating the SOAPElement object
See Also: SOAPElement.addChildElement(javax.xml.namespace.QName),

public SOAPElement addChildElement (QName qname) throws SOAPException

Creates a new SOAPElement object initialized with the given QName object and adds the new element to this SOAPElement object.

Creates a new SOAPElement object initialized with the given
QName object and adds the new element to this SOAPElement
object. The namespace, localname and prefix of the new
SOAPElement are all taken from the qname argument.
Returns: the new SOAPElement object that was created
Parameters:
- qname - a QName object with the XML name for the new element
Throws:
- SOAPException - if there is an error in creating the SOAPElement object
Since: SAAJ 1.3
See Also: SOAPElement.addChildElement(Name),

public SOAPElement addChildElement (SOAPElement element) throws SOAPException

Add a SOAPElement as a child of this SOAPElement instance.

Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPFactory. 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.
Returns: an instance representing the new SOAP element that was actually added to the tree.
Parameters:
- element - the SOAPElement to be added as a new child
Throws:
- SOAPException - if there was an error in adding this element as a child

public SOAPElement addChildElement (String localName) throws SOAPException

Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.

Creates a new SOAPElement object initialized with the
specified local name and adds the new element to this
SOAPElement object.
The new SOAPElement inherits any in-scope default namespace.
Returns: the new SOAPElement object that was created
Parameters:
- localName - a String giving the local name for the element
Throws:
- SOAPException - if there is an error in creating the SOAPElement object

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

Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.

Creates a new SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object.
Returns: the new SOAPElement object that was created
Parameters:
- localName - a String giving the local name for the new element
- prefix - a String giving the namespace prefix for the new element
Throws:
- SOAPException - if the prefix is not valid in the context of this SOAPElement or if there is an error in creating the SOAPElement object

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

Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.

Creates a new SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object.
Returns: the new SOAPElement object that was created
Parameters:
- localName - a String giving the local name for the new element
- prefix - a String giving the namespace prefix for the new element
- uri - a String giving the URI of the namespace to which the new element belongs
Throws:
- SOAPException - if there is an error in creating the SOAPElement object

public SOAPElement addNamespaceDeclaration (String prefix, String uri) throws SOAPException

Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.

Adds a namespace declaration with the specified prefix and URI to this
SOAPElement object.
Returns: the SOAPElement object into which this namespace declaration was inserted.
Parameters:
- prefix - a String giving the prefix of the namespace
- uri - a String giving the uri of the namespace
Throws:
- SOAPException - if there is an error in creating the namespace

public SOAPElement addTextNode (String text) throws SOAPException

Creates a new Text object initialized with the given String and adds it to this SOAPElement object.

Creates a new Text object initialized with the given
String and adds it to this SOAPElement object.
Returns: the SOAPElement object into which the new Text object was inserted
Parameters:
- text - a String object with the textual content to be added
Throws:
- SOAPException - if there is an error in creating the new Text object or if it is not legal to attach it as a child to this SOAPElement

public QName createQName (String localName, String prefix) throws SOAPException

Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement.

Creates a QName whose namespace URI is the one associated
with the parameter, prefix, in the context of this
SOAPElement. The remaining elements of the new
QName are taken directly from the parameters,
localName and prefix.
Returns: a QName with the specified localName and prefix, and with a namespace that is associated with the prefix in the context of this SOAPElement. This namespace will be the same as the one that would be returned by {@link #getNamespaceURI(String)} if it were given prefix as it's parameter.
Parameters:
- localName - a String containing the local part of the name.
- prefix - a String containing the prefix for the name.
Throws:
- SOAPException - if the QName cannot be created.
Since: SAAJ 1.3

public Iterator getAllAttributes ()

Returns an Iterator over all of the attribute Name objects in this SOAPElement object.

Returns an Iterator over all of the attribute
Name objects in this
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.
Returns: an iterator over the names of the attributes
See Also: SOAPElement.getAllAttributesAsQNames(),

public Iterator getAllAttributesAsQNames ()

Returns an Iterator over all of the attributes in this SOAPElement as QName objects.

Returns an Iterator over all of the attributes
in this SOAPElement as QName objects.
The iterator can be used to get the attribute QName, which can then
be passed to the method getAttributeValue to retrieve
the value of each attribute.
Returns: an iterator over the QNames of the attributes
Since: SAAJ 1.3
See Also: SOAPElement.getAllAttributes(),

public String getAttributeValue (Name name)

Returns the value of the attribute with the specified name.

Returns the value of the attribute with the specified name.
Returns: a String giving the value of the specified attribute, Null if there is no such attribute
Parameters:
- name - a Name object with the name of the attribute
See Also: SOAPElement.getAttributeValue(javax.xml.namespace.QName),

public String getAttributeValue (QName qname)

Returns the value of the attribute with the specified qname.

Returns the value of the attribute with the specified qname.
Returns: a String giving the value of the specified attribute, Null if there is no such attribute
Parameters:
- qname - a QName object with the qname of the attribute
Since: SAAJ 1.3
See Also: SOAPElement.getAttributeValue(Name),

public Iterator getChildElements ()

Returns an Iterator over all the immediate child Nodes of this element.

Returns an Iterator over all the immediate child Nodes of this element. This includes javax.xml.soap.Text objects as well as SOAPElement objects.

Calling this method may cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details.
Returns: an iterator with the content of this SOAPElement object

public Iterator getChildElements (Name name)

Returns an Iterator over all the immediate child Nodes of this element with the specified name.

Returns an Iterator over all the immediate child Nodes of this element with the specified name. All of these children will be SOAPElement nodes.

Calling this method may cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details.
Returns: an Iterator object over all the elements in this SOAPElement object with the specified name
Parameters:
- name - a Name object with the name of the child elements to be returned
See Also: SOAPElement.getChildElements(javax.xml.namespace.QName),

public Iterator getChildElements (QName qname)

Returns an Iterator over all the immediate child Nodes of this element with the specified qname.

Returns an Iterator over all the immediate child Nodes of this element with the specified qname. All of these children will be SOAPElement nodes.

Calling this method may cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details.
Returns: an Iterator object over all the elements in this SOAPElement object with the specified qname
Parameters:
- qname - a QName object with the qname of the child elements to be returned
Since: SAAJ 1.3
See Also: SOAPElement.getChildElements(Name),

public Name getElementName ()

Returns the name of this SOAPElement object.

Returns the name of this SOAPElement object.
Returns: a Name object with the name of this SOAPElement object

public QName getElementQName ()

Returns the qname of this SOAPElement object.

Returns the qname of this SOAPElement object.
Returns: a QName object with the qname of this SOAPElement object
Since: SAAJ 1.3
See Also: SOAPElement.getElementName(),

public String getEncodingStyle ()

Returns the encoding style for this SOAPElement object.

Returns the encoding style for this SOAPElement object.
Returns: a String giving the encoding style
See Also: SOAPElement.setEncodingStyle(java.lang.String),

public Iterator getNamespacePrefixes ()

Returns an Iterator over the namespace prefix Strings declared by this element.

Returns an Iterator over the namespace prefix
Strings declared by this element. The prefixes returned by
this iterator can be passed to the method
getNamespaceURI to retrieve the URI of each namespace.
Returns: an iterator over the namespace prefixes in this SOAPElement object

public String getNamespaceURI (String prefix)

Returns the URI of the namespace that has the given prefix.

Returns the URI of the namespace that has the given prefix.
Returns: a String with the uri of the namespace that has the given prefix
Parameters:
- prefix - a String giving the prefix of the namespace for which to search

public Iterator getVisibleNamespacePrefixes ()

Returns an Iterator over the namespace prefix Strings visible to this element.

Returns an 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.
Returns: an iterator over the namespace prefixes are within scope of this SOAPElement object
Since: SAAJ 1.2

public boolean removeAttribute (Name name)

Removes the attribute with the specified name.

Removes the attribute with the specified name.
Returns: true if the attribute was removed successfully; false if it was not
Parameters:
- name - the Name object with the name of the attribute to be removed
See Also: SOAPElement.removeAttribute(javax.xml.namespace.QName),

public boolean removeAttribute (QName qname)

Removes the attribute with the specified qname.

Removes the attribute with the specified qname.
Returns: true if the attribute was removed successfully; false if it was not
Parameters:
- qname - the QName object with the qname of the attribute to be removed
Since: SAAJ 1.3
See Also: SOAPElement.removeAttribute(Name),

public void removeContents ()

Detaches all children of this SOAPElement.

This method is useful for rolling back the construction of partially completed SOAPHeaders and SOAPBodys in preparation for sending a fault when an error condition is detected. It is also useful for recycling portions of a document within a SOAP message.
Since: SAAJ 1.2

public boolean removeNamespaceDeclaration (String prefix)

Removes the namespace declaration corresponding to the given prefix.

Removes the namespace declaration corresponding to the given prefix.
Returns: true if the namespace declaration was removed successfully; false if it was not
Parameters:
- prefix - a String giving the prefix for which to search

public SOAPElement setElementQName (QName newName) throws SOAPException

Changes the name of this Element to newName if possible.

Changes the name of this Element to newName if possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody etc. cannot have their names changed using this method. Any attempt to do so will result in a SOAPException being thrown.

Callers should not rely on the element instance being renamed as is. Implementations could end up copying the content of the SOAPElement to a renamed instance.
Returns: The renamed Node
Parameters:
- newName - the new name for the Element.
Throws:
- SOAPException - if changing the name of this Element is not allowed.
Since: SAAJ 1.3

public void setEncodingStyle (String encodingStyle) throws SOAPException

Sets the encoding style for this SOAPElement object to one specified.

Sets the encoding style for this SOAPElement object
to one specified.
Parameters:
- encodingStyle - a String giving the encoding style
Throws:
- IllegalArgumentException - if there was a problem in the encoding style being set.
- SOAPException - if setting the encodingStyle is invalid for this SOAPElement.
See Also: SOAPElement.getEncodingStyle(),