| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
An object representing the contents in a
 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.
| Field Summary | 
| Fields inherited from interface org.w3c.dom.Node | 
| ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE | 
| Method Summary | |
|  SOAPElement | addAttribute(Name name,
             java.lang.String value)Adds an attribute with the specified name and value to this SOAPElementobject. | 
|  SOAPElement | addChildElement(Name name)Creates a new SOAPElementobject initialized with the
 givenNameobject and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(SOAPElement element)Add a SOAPElementas a child of thisSOAPElementinstance. | 
|  SOAPElement | addChildElement(java.lang.String localName)Creates a new SOAPElementobject initialized with the
 givenStringobject and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(java.lang.String localName,
                java.lang.String prefix)Creates a new SOAPElementobject initialized with the
 specified local name and prefix and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(java.lang.String localName,
                java.lang.String prefix,
                java.lang.String uri)Creates a new SOAPElementobject initialized with the
 specified local name, prefix, and URI and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addNamespaceDeclaration(java.lang.String prefix,
                        java.lang.String uri)Adds a namespace declaration with the specified prefix and URI to this SOAPElementobject. | 
|  SOAPElement | addTextNode(java.lang.String text)Creates a new Textobject initialized with the givenStringand adds it to thisSOAPElementobject. | 
|  java.util.Iterator | getAllAttributes()Returns an iterator over all of the attribute names in this SOAPElementobject. | 
|  java.lang.String | getAttributeValue(Name name)Returns the value of the attribute with the specified name. | 
|  java.util.Iterator | getChildElements()Returns an iterator over all the immediate content of this element. | 
|  java.util.Iterator | getChildElements(Name name)Returns an iterator over all the child elements with the specified name. | 
|  Name | getElementName()Returns the name of this SOAPElementobject. | 
|  java.lang.String | getEncodingStyle()Returns the encoding style for this 
 SOAPElementobject. | 
|  java.util.Iterator | getNamespacePrefixes()Returns an iterator of namespace prefixes. | 
|  java.lang.String | getNamespaceURI(java.lang.String prefix)Returns the URI of the namespace that has the given prefix. | 
|  java.util.Iterator | getVisibleNamespacePrefixes()Returns an Iteratorover the namespace prefixStrings 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(java.lang.String prefix)Removes the namespace declaration corresponding to the given prefix. | 
|  void | setEncodingStyle(java.lang.String encodingStyle)Sets the encoding style for this SOAPElementobject to one specified. | 
| Methods inherited from interface javax.xml.soap.Node | 
| detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue | 
| Methods inherited from interface org.w3c.dom.Node | 
| appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix | 
| Methods inherited from interface org.w3c.dom.Element | 
| getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS | 
| Method Detail | 
public SOAPElement 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 element
SOAPElement object that was created
SOAPException - if there is an error in creating the
                     SOAPElement object
public SOAPElement addChildElement(java.lang.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 element
SOAPElement object that was created
SOAPException - if there is an error in creating the
                     SOAPElement object
public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.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 element
SOAPElement object that was created
SOAPException - if there is an error in creating the
                     SOAPElement object
public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.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 belongs
SOAPElement object that was created
SOAPException - if there is an error in creating the
                     SOAPElement object
public SOAPElement 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 child
SOAPException - if there was an error in adding this
                     element as a child
public SOAPElement addTextNode(java.lang.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 added
SOAPElement object into which
    the new Text object was inserted
SOAPException - if there is an error in creating the
               new Text object
public SOAPElement addAttribute(Name name,
                                java.lang.String value)
                         throws SOAPException
SOAPElement object.
 
name - a Name object with the name of the attributevalue - a String giving the value of the attribute
SOAPElement object into which the attribute was
    inserted
SOAPException - if there is an error in creating the
                     Attribute
public SOAPElement addNamespaceDeclaration(java.lang.String prefix,
                                           java.lang.String uri)
                                    throws SOAPException
SOAPElement object.
 
prefix - a String giving the prefix of the namespaceuri - a String giving
     the prefix of the namespace
SOAPElement object into which this
     namespace declaration was inserted.
SOAPException - if there is an error in creating the
                     namespacepublic java.lang.String getAttributeValue(Name name)
name - a Name object with
     the name of the attribute
String giving the value of the
     specified attributepublic java.util.Iterator 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.
public java.lang.String getNamespaceURI(java.lang.String prefix)
prefix - a String giving
     the prefix of the namespace for which to search
String with the uri of the namespace
     that has the given prefixpublic java.util.Iterator getNamespacePrefixes()
getNamespaceURI to retrieve
 the URI of each namespace.
SOAPElement objectpublic Name getElementName()
SOAPElement
 object.
Name object with the name of this
     SOAPElement objectpublic boolean removeAttribute(Name name)
name - the Name object with
     the name of the attribute to be removed
true if the attribute was removed
     successfully; false if it was notpublic boolean removeNamespaceDeclaration(java.lang.String prefix)
prefix - a String giving
     the prefix for which to search
true if the namespace declaration was
     removed successfully; false if it was
     notpublic java.util.Iterator getChildElements()
Text objects as well
 as SOAPElement objects.
     SOAPElement objectpublic java.util.Iterator getChildElements(Name name)
name - a Name object with
     the name of the child elements to be returned
Iterator object over all the elements
     in this SOAPElement object with the
     specified name
public void setEncodingStyle(java.lang.String encodingStyle)
                      throws SOAPException
SOAPElement
 object to one specified.
encodingStyle - a String
     giving the encoding style
java.lang.IllegalArgumentException - if
     there was a problem in the encoding style being set.
SOAPExceptiongetEncodingStyle()public java.lang.String getEncodingStyle()
 SOAPElement object.
String giving the encoding stylesetEncodingStyle(java.lang.String)public 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.
public java.util.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| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||