File	Doc	Category	Size	Date	Package
SOAPElement.java	API Doc	Java SE 6 API	22841	Tue Jun 10 00:27:10 BST 2008	javax.xml.soap

SOAPElement

Fields Summary

Constructors Summary

Methods Summary
public javax.xml.soap.SOAPElement	addAttribute(javax.xml.namespace.QName qname, java.lang.String value) Adds an attribute with the specified name and value to this SOAPElement object. param qname a QName object with the name of the attribute param value a String giving the value of the attribute return the SOAPElement object into which the attribute was inserted exception SOAPException if there is an error in creating the Attribute, or it is invalid to set an attribute with QName qname on this SOAPElement. see SOAPElement#addAttribute(Name, String) since SAAJ 1.3
public javax.xml.soap.SOAPElement	addAttribute(javax.xml.soap.Name name, java.lang.String value) Adds an attribute with the specified name and value to this SOAPElement object. param name a Name object with the name of the attribute param value a String giving the value of the attribute return the SOAPElement object into which the attribute was inserted exception 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 SOAPElement#addAttribute(javax.xml.namespace.QName, String)
public javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.Name name) 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) param name a Name object with the XML name for the new element return the new SOAPElement object that was created exception SOAPException if there is an error in creating the SOAPElement object see SOAPElement#addChildElement(javax.xml.namespace.QName)
public javax.xml.soap.SOAPElement	addChildElement(javax.xml.namespace.QName qname) 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. param qname a QName object with the XML name for the new element return the new SOAPElement object that was created exception SOAPException if there is an error in creating the SOAPElement object see SOAPElement#addChildElement(Name) since SAAJ 1.3
public javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName) 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. param localName a String giving the local name for the element return the new SOAPElement object that was created exception SOAPException if there is an error in creating the SOAPElement object
public javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix) Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object. param localName a String giving the local name for the new element param prefix a String giving the namespace prefix for the new element return the new SOAPElement object that was created exception 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 javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.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. param localName a String giving the local name for the new element param prefix a String giving the namespace prefix for the new element param uri a String giving the URI of the namespace to which the new element belongs return the new SOAPElement object that was created exception SOAPException if there is an error in creating the SOAPElement object
public javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.SOAPElement element) 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. param element the SOAPElement to be added as a new child exception SOAPException if there was an error in adding this element as a child return an instance representing the new SOAP element that was actually added to the tree.
public javax.xml.soap.SOAPElement	addNamespaceDeclaration(java.lang.String prefix, java.lang.String uri) Adds a namespace declaration with the specified prefix and URI to this SOAPElement object. param prefix a String giving the prefix of the namespace param uri a String giving the uri of the namespace return the SOAPElement object into which this namespace declaration was inserted. exception SOAPException if there is an error in creating the namespace
public javax.xml.soap.SOAPElement	addTextNode(java.lang.String text) Creates a new Text object initialized with the given String and adds it to this SOAPElement object. param text a String object with the textual content to be added return the SOAPElement object into which the new Text object was inserted exception 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 javax.xml.namespace.QName	createQName(java.lang.String localName, java.lang.String prefix) 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. param localName a String containing the local part of the name. param prefix a String containing the prefix for the name. return 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. exception SOAPException if the QName cannot be created. since SAAJ 1.3
public java.util.Iterator	getAllAttributes() 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. see SOAPElement#getAllAttributesAsQNames() return an iterator over the names of the attributes
public java.util.Iterator	getAllAttributesAsQNames() 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. return an iterator over the QNames of the attributes see SOAPElement#getAllAttributes() since SAAJ 1.3
public java.lang.String	getAttributeValue(javax.xml.soap.Name name) Returns the value of the attribute with the specified name. param name a Name object with the name of the attribute return a String giving the value of the specified attribute, Null if there is no such attribute see SOAPElement#getAttributeValue(javax.xml.namespace.QName)
public java.lang.String	getAttributeValue(javax.xml.namespace.QName qname) Returns the value of the attribute with the specified qname. param qname a QName object with the qname of the attribute return a String giving the value of the specified attribute, Null if there is no such attribute see SOAPElement#getAttributeValue(Name) since SAAJ 1.3
public java.util.Iterator	getChildElements() Returns an Iterator over all the immediate child {@link Node}s 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 {@link javax.xml.soap} for more details. return an iterator with the content of this SOAPElement object
public java.util.Iterator	getChildElements(javax.xml.soap.Name name) Returns an Iterator over all the immediate child {@link Node}s 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 {@link javax.xml.soap} for more details. param name a Name object with the name of the child elements to be returned return an Iterator object over all the elements in this SOAPElement object with the specified name see SOAPElement#getChildElements(javax.xml.namespace.QName)
public java.util.Iterator	getChildElements(javax.xml.namespace.QName qname) Returns an Iterator over all the immediate child {@link Node}s 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 {@link javax.xml.soap} for more details. param qname a QName object with the qname of the child elements to be returned return an Iterator object over all the elements in this SOAPElement object with the specified qname see SOAPElement#getChildElements(Name) since SAAJ 1.3
public javax.xml.soap.Name	getElementName() Returns the name of this SOAPElement object. return a Name object with the name of this SOAPElement object
public javax.xml.namespace.QName	getElementQName() Returns the qname of this SOAPElement object. return a QName object with the qname of this SOAPElement object see SOAPElement#getElementName() since SAAJ 1.3
public java.lang.String	getEncodingStyle() Returns the encoding style for this SOAPElement object. return a String giving the encoding style see #setEncodingStyle
public java.util.Iterator	getNamespacePrefixes() 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. return an iterator over the namespace prefixes in this SOAPElement object
public java.lang.String	getNamespaceURI(java.lang.String prefix) Returns the URI of the namespace that has the given prefix. param prefix a String giving the prefix of the namespace for which to search return a String with the uri of the namespace that has the given prefix
public java.util.Iterator	getVisibleNamespacePrefixes() 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. return an iterator over the namespace prefixes are within scope of this SOAPElement object since SAAJ 1.2
public boolean	removeAttribute(javax.xml.soap.Name name) Removes the attribute with the specified name. param name the Name object with the name of the attribute to be removed return true if the attribute was removed successfully; false if it was not see SOAPElement#removeAttribute(javax.xml.namespace.QName)
public boolean	removeAttribute(javax.xml.namespace.QName qname) Removes the attribute with the specified qname. param qname the QName object with the qname of the attribute to be removed return true if the attribute was removed successfully; false if it was not see SOAPElement#removeAttribute(Name) since SAAJ 1.3
public abstract 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(java.lang.String prefix) Removes the namespace declaration corresponding to the given prefix. param prefix a String giving the prefix for which to search return true if the namespace declaration was removed successfully; false if it was not
public javax.xml.soap.SOAPElement	setElementQName(javax.xml.namespace.QName newName) 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. param newName the new name for the Element. exception SOAPException if changing the name of this Element is not allowed. return The renamed Node since SAAJ 1.3
public void	setEncodingStyle(java.lang.String encodingStyle) Sets the encoding style for this SOAPElement object to one specified. param encodingStyle a String giving the encoding style exception IllegalArgumentException if there was a problem in the encoding style being set. exception SOAPException if setting the encodingStyle is invalid for this SOAPElement. see #getEncodingStyle