| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPElement</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPElement"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/SOAPConstants.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/SOAPElementFactory.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/SOAPElement.html" target="_top">Frames</a></li> |
| <li><a href="SOAPElement.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.soap</div> |
| <h2 title="Interface SOAPElement" class="title">Interface SOAPElement</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>org.w3c.dom.Element, org.w3c.dom.Node</dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../jakarta/xml/soap/Detail.html" title="interface in jakarta.xml.soap">Detail</a>, <a href="../../../jakarta/xml/soap/DetailEntry.html" title="interface in jakarta.xml.soap">DetailEntry</a>, <a href="../../../jakarta/xml/soap/SOAPBody.html" title="interface in jakarta.xml.soap">SOAPBody</a>, <a href="../../../jakarta/xml/soap/SOAPBodyElement.html" title="interface in jakarta.xml.soap">SOAPBodyElement</a>, <a href="../../../jakarta/xml/soap/SOAPEnvelope.html" title="interface in jakarta.xml.soap">SOAPEnvelope</a>, <a href="../../../jakarta/xml/soap/SOAPFault.html" title="interface in jakarta.xml.soap">SOAPFault</a>, <a href="../../../jakarta/xml/soap/SOAPFaultElement.html" title="interface in jakarta.xml.soap">SOAPFaultElement</a>, <a href="../../../jakarta/xml/soap/SOAPHeader.html" title="interface in jakarta.xml.soap">SOAPHeader</a>, <a href="../../../jakarta/xml/soap/SOAPHeaderElement.html" title="interface in jakarta.xml.soap">SOAPHeaderElement</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SOAPElement</span> |
| extends <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>, org.w3c.dom.Element</pre> |
| <div class="block">An object representing an element of a SOAP message that is allowed but not |
| specifically prescribed by a SOAP specification. This interface serves as the |
| base interface for those objects that are specifically prescribed by a SOAP |
| specification. |
| <p> |
| Methods in this interface that are required to return SAAJ specific objects |
| may "silently" replace nodes in the tree as required to successfully return |
| objects of the correct type. See <a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements--"><code>getChildElements()</code></a> and |
| <a href="../../../jakarta/xml/soap/package-summary.html"><code>jakarta.xml.soap</code></a> for details.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.w3c.dom.Node"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.w3c.dom.Node</h3> |
| <code>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</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-jakarta.xml.soap.Name-java.lang.String-">addAttribute</a></span>(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name, |
| java.lang.String value)</code> |
| <div class="block">Adds an attribute with the specified name and value to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-javax.xml.namespace.QName-java.lang.String-">addAttribute</a></span>(javax.xml.namespace.QName qname, |
| java.lang.String value)</code> |
| <div class="block">Adds an attribute with the specified name and value to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-jakarta.xml.soap.Name-">addChildElement</a></span>(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</code> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| given <code>Name</code> object and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-javax.xml.namespace.QName-">addChildElement</a></span>(javax.xml.namespace.QName qname)</code> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the given |
| <code>QName</code> object and adds the new element to this <code>SOAPElement</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-jakarta.xml.soap.SOAPElement-">addChildElement</a></span>(<a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> element)</code> |
| <div class="block">Add a <code>SOAPElement</code> as a child of this |
| <code>SOAPElement</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-">addChildElement</a></span>(java.lang.String localName)</code> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-">addChildElement</a></span>(java.lang.String localName, |
| java.lang.String prefix)</code> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name and prefix and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-java.lang.String-">addChildElement</a></span>(java.lang.String localName, |
| java.lang.String prefix, |
| java.lang.String uri)</code> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name, prefix, and URI and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addNamespaceDeclaration-java.lang.String-java.lang.String-">addNamespaceDeclaration</a></span>(java.lang.String prefix, |
| java.lang.String uri)</code> |
| <div class="block">Adds a namespace declaration with the specified prefix and URI to this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#addTextNode-java.lang.String-">addTextNode</a></span>(java.lang.String text)</code> |
| <div class="block">Creates a new <code>Text</code> object initialized with the given |
| <code>String</code> and adds it to this <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>javax.xml.namespace.QName</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#createQName-java.lang.String-java.lang.String-">createQName</a></span>(java.lang.String localName, |
| java.lang.String prefix)</code> |
| <div class="block">Creates a <code>QName</code> whose namespace URI is the one associated |
| with the parameter, <code>prefix</code>, in the context of this |
| <code>SOAPElement</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributes--">getAllAttributes</a></span>()</code> |
| <div class="block">Returns an <code>Iterator</code> over all of the attribute |
| <code>Name</code> objects in this |
| <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<javax.xml.namespace.QName></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributesAsQNames--">getAllAttributesAsQNames</a></span>()</code> |
| <div class="block">Returns an <code>Iterator</code> over all of the attributes |
| in this <code>SOAPElement</code> as <code>QName</code> objects.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-jakarta.xml.soap.Name-">getAttributeValue</a></span>(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</code> |
| <div class="block">Returns the value of the attribute with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-javax.xml.namespace.QName-">getAttributeValue</a></span>(javax.xml.namespace.QName qname)</code> |
| <div class="block">Returns the value of the attribute with the specified qname.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements--">getChildElements</a></span>()</code> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-jakarta.xml.soap.Name-">getChildElements</a></span>(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</code> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-javax.xml.namespace.QName-">getChildElements</a></span>(javax.xml.namespace.QName qname)</code> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element with the specified qname.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getElementName--">getElementName</a></span>()</code> |
| <div class="block">Returns the name of this <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>javax.xml.namespace.QName</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getElementQName--">getElementQName</a></span>()</code> |
| <div class="block">Returns the qname of this <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getEncodingStyle--">getEncodingStyle</a></span>()</code> |
| <div class="block">Returns the encoding style for this <code>SOAPElement</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getNamespacePrefixes--">getNamespacePrefixes</a></span>()</code> |
| <div class="block">Returns an <code>Iterator</code> over the namespace prefix |
| <code>String</code>s declared by this element.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getNamespaceURI-java.lang.String-">getNamespaceURI</a></span>(java.lang.String prefix)</code> |
| <div class="block">Returns the URI of the namespace that has the given prefix.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#getVisibleNamespacePrefixes--">getVisibleNamespacePrefixes</a></span>()</code> |
| <div class="block">Returns an <code>Iterator</code> over the namespace prefix |
| <code>String</code>s visible to this element.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-jakarta.xml.soap.Name-">removeAttribute</a></span>(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</code> |
| <div class="block">Removes the attribute with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-javax.xml.namespace.QName-">removeAttribute</a></span>(javax.xml.namespace.QName qname)</code> |
| <div class="block">Removes the attribute with the specified qname.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#removeContents--">removeContents</a></span>()</code> |
| <div class="block">Detaches all children of this <code>SOAPElement</code>.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#removeNamespaceDeclaration-java.lang.String-">removeNamespaceDeclaration</a></span>(java.lang.String prefix)</code> |
| <div class="block">Removes the namespace declaration corresponding to the given prefix.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#setElementQName-javax.xml.namespace.QName-">setElementQName</a></span>(javax.xml.namespace.QName newName)</code> |
| <div class="block">Changes the name of this <code>Element</code> to <code>newName</code> if |
| possible.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPElement.html#setEncodingStyle-java.lang.String-">setEncodingStyle</a></span>(java.lang.String encodingStyle)</code> |
| <div class="block">Sets the encoding style for this <code>SOAPElement</code> object |
| to one specified.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.xml.soap.Node"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.xml.soap.<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a></h3> |
| <code><a href="../../../jakarta/xml/soap/Node.html#detachNode--">detachNode</a>, <a href="../../../jakarta/xml/soap/Node.html#getParentElement--">getParentElement</a>, <a href="../../../jakarta/xml/soap/Node.html#getValue--">getValue</a>, <a href="../../../jakarta/xml/soap/Node.html#recycleNode--">recycleNode</a>, <a href="../../../jakarta/xml/soap/Node.html#setParentElement-jakarta.xml.soap.SOAPElement-">setParentElement</a>, <a href="../../../jakarta/xml/soap/Node.html#setValue-java.lang.String-">setValue</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Element"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.w3c.dom.Element</h3> |
| <code>getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Node"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.w3c.dom.Node</h3> |
| <code>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</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addChildElement-jakarta.xml.soap.Name-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| given <code>Name</code> object and adds the new element to this |
| <code>SOAPElement</code> object. |
| <P> |
| This method may be deprecated in a future release of SAAJ in favor of |
| addChildElement(javax.xml.namespace.QName)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>Name</code> object with the XML name for the |
| new element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>SOAPElement</code> object that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| <code>SOAPElement</code> object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-javax.xml.namespace.QName-"><code>addChildElement(javax.xml.namespace.QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addChildElement-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(javax.xml.namespace.QName qname) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the given |
| <code>QName</code> object and adds the new element to this <code>SOAPElement</code> |
| object. The <i>namespace</i>, <i>localname</i> and <i>prefix</i> of the new |
| <code>SOAPElement</code> are all taken from the <code>qname</code> argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a <code>QName</code> object with the XML name for the |
| new element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>SOAPElement</code> object that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| <code>SOAPElement</code> object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-jakarta.xml.soap.Name-"><code>addChildElement(Name)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addChildElement-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(java.lang.String localName) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name and adds the new element to this |
| <code>SOAPElement</code> object. |
| The new <code>SOAPElement</code> inherits any in-scope default namespace.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localName</code> - a <code>String</code> giving the local name for |
| the element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>SOAPElement</code> object that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| <code>SOAPElement</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addChildElement-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(java.lang.String localName, |
| java.lang.String prefix) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name and prefix and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localName</code> - a <code>String</code> giving the local name for |
| the new element</dd> |
| <dd><code>prefix</code> - a <code>String</code> giving the namespace prefix for |
| the new element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>SOAPElement</code> object that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if the <code>prefix</code> is not valid in the |
| context of this <code>SOAPElement</code> or if there is an error in creating the |
| <code>SOAPElement</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addChildElement-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(java.lang.String localName, |
| java.lang.String prefix, |
| java.lang.String uri) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>SOAPElement</code> object initialized with the |
| specified local name, prefix, and URI and adds the new element to this |
| <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localName</code> - a <code>String</code> giving the local name for |
| the new element</dd> |
| <dd><code>prefix</code> - a <code>String</code> giving the namespace prefix for |
| the new element</dd> |
| <dd><code>uri</code> - a <code>String</code> giving the URI of the namespace |
| to which the new element belongs</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>SOAPElement</code> object that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| <code>SOAPElement</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addChildElement-jakarta.xml.soap.SOAPElement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildElement</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addChildElement(<a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> element) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Add a <code>SOAPElement</code> as a child of this |
| <code>SOAPElement</code> instance. The <code>SOAPElement</code> |
| is expected to be created by a |
| <code>SOAPFactory</code>. 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 <code>SOAPElement</code> passed into an instance of |
| a different <code>SOAPElement</code> implementation. For |
| instance if <code>addChildElement()</code> is called on a |
| <code>SOAPHeader</code>, <code>element</code> will be copied |
| into an instance of a <code>SOAPHeaderElement</code>. |
| |
| <P>The fragment rooted in <code>element</code> is either added |
| as a whole or not at all, if there was an error. |
| |
| <P>The fragment rooted in <code>element</code> 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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>element</code> - the <code>SOAPElement</code> to be added as a |
| new child</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance representing the new SOAP element that was |
| actually added to the tree.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there was an error in adding this |
| element as a child</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeContents--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeContents</h4> |
| <pre>void removeContents()</pre> |
| <div class="block">Detaches all children of this <code>SOAPElement</code>. |
| <p> |
| This method is useful for rolling back the construction of partially |
| completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> 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.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addTextNode-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTextNode</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addTextNode(java.lang.String text) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <code>Text</code> object initialized with the given |
| <code>String</code> and adds it to this <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>text</code> - a <code>String</code> object with the textual content to be added</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPElement</code> object into which |
| the new <code>Text</code> object was inserted</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| new <code>Text</code> object or if it is not legal to |
| attach it as a child to this |
| <code>SOAPElement</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttribute-jakarta.xml.soap.Name-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addAttribute(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name, |
| java.lang.String value) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Adds an attribute with the specified name and value to this |
| <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>Name</code> object with the name of the attribute</dd> |
| <dd><code>value</code> - a <code>String</code> giving the value of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPElement</code> object into which the attribute was |
| inserted</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| Attribute, or it is invalid to set |
| an attribute with <code>Name</code> |
| <code>name</code> on this SOAPElement.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-javax.xml.namespace.QName-java.lang.String-"><code>addAttribute(javax.xml.namespace.QName, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttribute-javax.xml.namespace.QName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addAttribute(javax.xml.namespace.QName qname, |
| java.lang.String value) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Adds an attribute with the specified name and value to this |
| <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a <code>QName</code> object with the name of the attribute</dd> |
| <dd><code>value</code> - a <code>String</code> giving the value of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPElement</code> object into which the attribute was |
| inserted</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| Attribute, or it is invalid to set |
| an attribute with <code>QName</code> |
| <code>qname</code> on this SOAPElement.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-jakarta.xml.soap.Name-java.lang.String-"><code>addAttribute(Name, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addNamespaceDeclaration-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addNamespaceDeclaration</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> addNamespaceDeclaration(java.lang.String prefix, |
| java.lang.String uri) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Adds a namespace declaration with the specified prefix and URI to this |
| <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - a <code>String</code> giving the prefix of the namespace</dd> |
| <dd><code>uri</code> - a <code>String</code> giving the uri of the namespace</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPElement</code> object into which this |
| namespace declaration was inserted.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in creating the |
| namespace</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeValue-jakarta.xml.soap.Name-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeValue</h4> |
| <pre>java.lang.String getAttributeValue(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</pre> |
| <div class="block">Returns the value of the attribute with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>Name</code> object with the name of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the specified |
| attribute, Null if there is no such attribute</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-javax.xml.namespace.QName-"><code>getAttributeValue(javax.xml.namespace.QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeValue-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeValue</h4> |
| <pre>java.lang.String getAttributeValue(javax.xml.namespace.QName qname)</pre> |
| <div class="block">Returns the value of the attribute with the specified qname.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a <code>QName</code> object with the qname of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the specified |
| attribute, Null if there is no such attribute</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-jakarta.xml.soap.Name-"><code>getAttributeValue(Name)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllAttributes</h4> |
| <pre>java.util.Iterator<<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a>> getAllAttributes()</pre> |
| <div class="block">Returns an <code>Iterator</code> over all of the attribute |
| <code>Name</code> objects in this |
| <code>SOAPElement</code> object. The iterator can be used to get |
| the attribute names, which can then be passed to the method |
| <code>getAttributeValue</code> to retrieve the value of each |
| attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the names of the attributes</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributesAsQNames--"><code>getAllAttributesAsQNames()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllAttributesAsQNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllAttributesAsQNames</h4> |
| <pre>java.util.Iterator<javax.xml.namespace.QName> getAllAttributesAsQNames()</pre> |
| <div class="block">Returns an <code>Iterator</code> over all of the attributes |
| in this <code>SOAPElement</code> as <code>QName</code> objects. |
| The iterator can be used to get the attribute QName, which can then |
| be passed to the method <code>getAttributeValue</code> to retrieve |
| the value of each attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the QNames of the attributes</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributes--"><code>getAllAttributes()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespaceURI-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespaceURI</h4> |
| <pre>java.lang.String getNamespaceURI(java.lang.String prefix)</pre> |
| <div class="block">Returns the URI of the namespace that has the given prefix.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - a <code>String</code> giving the prefix of the namespace |
| for which to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> with the uri of the namespace that has |
| the given prefix</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespacePrefixes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespacePrefixes</h4> |
| <pre>java.util.Iterator<java.lang.String> getNamespacePrefixes()</pre> |
| <div class="block">Returns an <code>Iterator</code> over the namespace prefix |
| <code>String</code>s declared by this element. The prefixes returned by |
| this iterator can be passed to the method |
| <code>getNamespaceURI</code> to retrieve the URI of each namespace.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the namespace prefixes in this |
| <code>SOAPElement</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVisibleNamespacePrefixes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVisibleNamespacePrefixes</h4> |
| <pre>java.util.Iterator<java.lang.String> getVisibleNamespacePrefixes()</pre> |
| <div class="block">Returns an <code>Iterator</code> over the namespace prefix |
| <code>String</code>s visible to this element. The prefixes returned by |
| this iterator can be passed to the method |
| <code>getNamespaceURI</code> to retrieve the URI of each namespace.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the namespace prefixes are within scope of this |
| <code>SOAPElement</code> object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createQName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQName</h4> |
| <pre>javax.xml.namespace.QName createQName(java.lang.String localName, |
| java.lang.String prefix) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a <code>QName</code> whose namespace URI is the one associated |
| with the parameter, <code>prefix</code>, in the context of this |
| <code>SOAPElement</code>. The remaining elements of the new |
| <code>QName</code> are taken directly from the parameters, |
| <code>localName</code> and <code>prefix</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localName</code> - a <code>String</code> containing the local part of the name.</dd> |
| <dd><code>prefix</code> - a <code>String</code> containing the prefix for the name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>QName</code> with the specified <code>localName</code> |
| and <code>prefix</code>, and with a namespace that is associated |
| with the <code>prefix</code> in the context of this |
| <code>SOAPElement</code>. This namespace will be the same as |
| the one that would be returned by |
| <a href="../../../jakarta/xml/soap/SOAPElement.html#getNamespaceURI-java.lang.String-"><code>getNamespaceURI(String)</code></a> if it were given |
| <code>prefix</code> as it's parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if the <code>QName</code> cannot be created.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getElementName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElementName</h4> |
| <pre><a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> getElementName()</pre> |
| <div class="block">Returns the name of this <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Name</code> object with the name of this |
| <code>SOAPElement</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getElementQName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElementQName</h4> |
| <pre>javax.xml.namespace.QName getElementQName()</pre> |
| <div class="block">Returns the qname of this <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>QName</code> object with the qname of this |
| <code>SOAPElement</code> object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getElementName--"><code>getElementName()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setElementQName-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setElementQName</h4> |
| <pre><a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a> setElementQName(javax.xml.namespace.QName newName) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Changes the name of this <code>Element</code> to <code>newName</code> 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. |
| <P> |
| Callers should not rely on the element instance being renamed as is. |
| Implementations could end up copying the content of the |
| <code>SOAPElement</code> to a renamed instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newName</code> - the new name for the <code>Element</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The renamed Node</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if changing the name of this <code>Element</code> |
| is not allowed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAttribute-jakarta.xml.soap.Name-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre>boolean removeAttribute(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</pre> |
| <div class="block">Removes the attribute with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the <code>Name</code> object with the name of the |
| attribute to be removed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the attribute was |
| removed successfully; <code>false</code> if it was not</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-javax.xml.namespace.QName-"><code>removeAttribute(javax.xml.namespace.QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAttribute-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre>boolean removeAttribute(javax.xml.namespace.QName qname)</pre> |
| <div class="block">Removes the attribute with the specified qname.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - the <code>QName</code> object with the qname of the |
| attribute to be removed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the attribute was |
| removed successfully; <code>false</code> if it was not</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-jakarta.xml.soap.Name-"><code>removeAttribute(Name)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeNamespaceDeclaration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeNamespaceDeclaration</h4> |
| <pre>boolean removeNamespaceDeclaration(java.lang.String prefix)</pre> |
| <div class="block">Removes the namespace declaration corresponding to the given prefix.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - a <code>String</code> giving the prefix for which |
| to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the namespace declaration was |
| removed successfully; <code>false</code> if it was not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChildElements--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildElements</h4> |
| <pre>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>> getChildElements()</pre> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element. This includes <code>jakarta.xml.soap.Text</code> |
| objects as well as <code>SOAPElement</code> objects. |
| <p> |
| Calling this method must cause child <code>Element</code>, |
| <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be |
| replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>, |
| <code>SOAPBodyElement</code> or <code>jakarta.xml.soap.Text</code> 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 <code>Iterator</code>. This |
| behavior can be avoided by calling the equivalent DOM APIs. See |
| <a href="../../../jakarta/xml/soap/package-summary.html"><code>jakarta.xml.soap</code></a> |
| for more details.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator with the content of this <code>SOAPElement</code> |
| object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChildElements-jakarta.xml.soap.Name-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildElements</h4> |
| <pre>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>> getChildElements(<a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap">Name</a> name)</pre> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element with the specified name. All of these |
| children will be <code>SOAPElement</code> nodes. |
| <p> |
| Calling this method must cause child <code>Element</code>, |
| <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be |
| replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>, |
| <code>SOAPBodyElement</code> or <code>jakarta.xml.soap.Text</code> 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 <code>Iterator</code>. This |
| behavior can be avoided by calling the equivalent DOM APIs. See |
| <a href="../../../jakarta/xml/soap/package-summary.html"><code>jakarta.xml.soap</code></a> |
| for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>Name</code> object with the name of the child |
| elements to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object over all the elements |
| in this <code>SOAPElement</code> object with the |
| specified name</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-javax.xml.namespace.QName-"><code>getChildElements(javax.xml.namespace.QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChildElements-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildElements</h4> |
| <pre>java.util.Iterator<<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a>> getChildElements(javax.xml.namespace.QName qname)</pre> |
| <div class="block">Returns an <code>Iterator</code> over all the immediate child |
| <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap"><code>Node</code></a>s of this element with the specified qname. All of these |
| children will be <code>SOAPElement</code> nodes. |
| <p> |
| Calling this method must cause child <code>Element</code>, |
| <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be |
| replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>, |
| <code>SOAPBodyElement</code> or <code>jakarta.xml.soap.Text</code> 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 <code>Iterator</code>. This |
| behavior can be avoided by calling the equivalent DOM APIs. See |
| <a href="../../../jakarta/xml/soap/package-summary.html"><code>jakarta.xml.soap</code></a> |
| for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a <code>QName</code> object with the qname of the child |
| elements to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object over all the elements |
| in this <code>SOAPElement</code> object with the |
| specified qname</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-jakarta.xml.soap.Name-"><code>getChildElements(Name)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncodingStyle-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncodingStyle</h4> |
| <pre>void setEncodingStyle(java.lang.String encodingStyle) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Sets the encoding style for this <code>SOAPElement</code> object |
| to one specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodingStyle</code> - a <code>String</code> giving the encoding style</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem in the |
| encoding style being set.</dd> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if setting the encodingStyle is invalid for this SOAPElement.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#getEncodingStyle--"><code>getEncodingStyle()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncodingStyle--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEncodingStyle</h4> |
| <pre>java.lang.String getEncodingStyle()</pre> |
| <div class="block">Returns the encoding style for this <code>SOAPElement</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the encoding style</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPElement.html#setEncodingStyle-java.lang.String-"><code>setEncodingStyle(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/SOAPConstants.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/SOAPElementFactory.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/SOAPElement.html" target="_top">Frames</a></li> |
| <li><a href="SOAPElement.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |