Package org.apache.axis2.saaj
Class SOAPPartImpl
- java.lang.Object
- 
- javax.xml.soap.SOAPPart
- 
- org.apache.axis2.saaj.SOAPPartImpl
 
 
- 
- 
Field Summary- 
Fields inherited from interface org.w3c.dom.NodeATTRIBUTE_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
 
- 
 - 
Constructor SummaryConstructors Constructor Description SOAPPartImpl(SOAPMessageImpl parentSoapMsg, InputStream inputStream, MimeHeaders mimeHeaders, Attachments attachments)Construct a SOAP part from the given input stream.SOAPPartImpl(SOAPMessageImpl parentSoapMsg, SOAPEnvelopeImpl soapEnvelope)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddMimeHeader(String header, String value)Creates aMimeHeaderobject with the specified name and value and adds it to thisSOAPPartobject.NodeadoptNode(Node source)NodeappendChild(Node newChild)Adds the nodenewChildto the end of the list of children of this node.NodecloneNode(boolean deep)Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.shortcompareDocumentPosition(Node node)AttrcreateAttribute(String name)Creates anAttrof the given name.AttrcreateAttributeNS(String namespaceURI, String qualifiedName)Creates an attribute of the given qualified name and namespace URI.CDATASectioncreateCDATASection(String data)Creates aCDATASectionnode whose value is the specified string.CommentcreateComment(String data)Creates aCDATASectionnode whose value is the specified string.DocumentFragmentcreateDocumentFragment()Creates an emptyDocumentFragmentobject.ElementcreateElement(String tagName)Creates an element of the type specified.ElementcreateElementNS(String namespaceURI, String qualifiedName)Creates an element of the given qualified name and namespace URI.EntityReferencecreateEntityReference(String name)Creates anEntityReferenceobject.ProcessingInstructioncreateProcessingInstruction(String target, String data)Creates aProcessingInstructionnode given the specified name and data strings.TextcreateTextNode(String data)Creates aTextnode given the specified string.voiddetachNode()IteratorgetAllMimeHeaders()Retrieves all the headers for thisSOAPPartobject as an iterator over theMimeHeaderobjects.NamedNodeMapgetAttributes()ANamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.StringgetBaseURI()NodeListgetChildNodes()ANodeListthat contains all children of this node.SourcegetContent()Returns the content of the SOAPEnvelope as a JAXPSourceobject.DocumentTypegetDoctype()The Document Type Declaration (seeDocumentType) associated with this document.ElementgetDocumentElement()This is a convenience attribute that allows direct access to the child node that is the root element of the document.StringgetDocumentURI()DOMConfigurationgetDomConfig()ElementgetElementById(String elementId)Returns theElementwhoseIDis given byelementId.NodeListgetElementsByTagName(String tagname)Returns aNodeListof all theElementswith a given tag name in the order in which they are encountered in a preorder traversal of theDocumenttree.NodeListgetElementsByTagNameNS(String namespaceURI, String localName)Returns aNodeListof all theElementswith a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocumenttree.SOAPEnvelopegetEnvelope()Gets theSOAPEnvelopeobject associated with thisSOAPPartobject.ObjectgetFeature(String feature, String version)NodegetFirstChild()The first child of this node.DOMImplementationgetImplementation()TheDOMImplementationobject that handles this document.StringgetInputEncoding()NodegetLastChild()The last child of this node.StringgetLocalName()Returns the local part of the qualified name of this node.IteratorgetMatchingMimeHeaders(String[] names)Retrieves allMimeHeaderobjects that match a name in the given array.String[]getMimeHeader(String name)Gets all the values of theMimeHeaderobject in thisSOAPPartobject that is identified by the givenString.StringgetNamespaceURI()The namespace URI of this node, ornullif it is unspecified.NodegetNextSibling()The node immediately following this node.StringgetNodeName()The name of this node, depending on its type; see the table above.shortgetNodeType()A code representing the type of the underlying object, as defined above.StringgetNodeValue()The value of this node, depending on its type; see the table above.IteratorgetNonMatchingMimeHeaders(String[] names)Retrieves allMimeHeaderobjects whose name does not match a name in the given array.DocumentgetOwnerDocument()TheDocumentobject associated with this node.SOAPElementgetParentElement()NodegetParentNode()The parent of this node.StringgetPrefix()The namespace prefix of this node, ornullif it is unspecified.NodegetPreviousSibling()The node immediately preceding this node.SOAPMessagegetSoapMessage()Obtain the SOAPMessagebooleangetStrictErrorChecking()StringgetTextContent()ObjectgetUserData(String key)StringgetValue()StringgetXmlEncoding()booleangetXmlStandalone()StringgetXmlVersion()booleanhasAttributes()Returns whether this node (if it is an element) has any attributes.booleanhasChildNodes()Returns whether this node has any children.NodeimportNode(Node importedNode, boolean deep)Imports a node from another document to this document.NodeinsertBefore(Node newChild, Node refChild)Inserts the nodenewChildbefore the existing child noderefChild.booleanisDefaultNamespace(String namespaceURI)booleanisEqualNode(Node node)booleanisSameNode(Node other)booleanisSupported(String feature, String version)Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.StringlookupNamespaceURI(String prefix)StringlookupPrefix(String namespaceURI)voidnormalize()Puts allTextnodes in the full depth of the sub-tree underneath thisNode, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes.voidnormalizeDocument()voidrecycleNode()voidremoveAllMimeHeaders()Removes all theMimeHeaderobjects for thisSOAPEnvelopeobject.NoderemoveChild(Node oldChild)Removes the child node indicated byoldChildfrom the list of children, and returns it.voidremoveMimeHeader(String header)Removes all MIME headers that match the given name.NoderenameNode(Node n, String namespaceURI, String qualifiedName)NodereplaceChild(Node newChild, Node oldChild)Replaces the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode.voidsetContent(Source source)voidsetDocumentURI(String documentURI)protected voidsetMessage(SOAPMessageImpl message)voidsetMimeHeader(String name, String value)Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match.voidsetNodeValue(String arg0)The value of this node, depending on its type; see the table above.voidsetParentElement(SOAPElement parent)voidsetPrefix(String arg0)The namespace prefix of this node, ornullif it is unspecified.voidsetStrictErrorChecking(boolean strictErrorChecking)voidsetTextContent(String textContent)ObjectsetUserData(String key, Object data, UserDataHandler handler)voidsetValue(String value)voidsetXmlStandalone(boolean xmlStandalone)voidsetXmlVersion(String xmlVersion)- 
Methods inherited from class javax.xml.soap.SOAPPartgetContentId, getContentLocation, setContentId, setContentLocation
 
- 
 
- 
- 
- 
Constructor Detail- 
SOAPPartImplpublic SOAPPartImpl(SOAPMessageImpl parentSoapMsg, SOAPEnvelopeImpl soapEnvelope) 
 - 
SOAPPartImplpublic SOAPPartImpl(SOAPMessageImpl parentSoapMsg, InputStream inputStream, MimeHeaders mimeHeaders, Attachments attachments) throws SOAPException Construct a SOAP part from the given input stream. The content type (as provided by the MIME headers) must be SOAP 1.1, SOAP 1.2 or XOP (MTOM). MIME packages (multipart/related) are not supported and should be parsed using {@link SOAPMessageImpl#SOAPMessageImpl(InputStream, MimeHeaders).If the content type is XOP, xop:Include elements will only be replaced if the attachmentsparameter is not null.- Parameters:
- parentSoapMsg- the parent SOAP message
- inputStream- the input stream with the content of the SOAP part
- mimeHeaders- the MIME headers
- attachments- the set of attachments to be used to substitute xop:Include elements
- Throws:
- SOAPException
- See Also:
- MessageFactoryImpl.setProcessMTOM(boolean)
 
 
- 
 - 
Method Detail- 
getSoapMessagepublic SOAPMessage getSoapMessage() Obtain the SOAPMessage- Returns:
- the related SOAPMessage
 
 - 
getEnvelopepublic SOAPEnvelope getEnvelope() throws SOAPException Gets theSOAPEnvelopeobject associated with thisSOAPPartobject. Once the SOAP envelope is obtained, it can be used to get its contents.- Specified by:
- getEnvelopein class- SOAPPart
- Returns:
- the SOAPEnvelopeobject for thisSOAPPartobject
- Throws:
- SOAPException- if there is a SOAP error
 
 - 
removeMimeHeaderpublic void removeMimeHeader(String header) Removes all MIME headers that match the given name.- Specified by:
- removeMimeHeaderin class- SOAPPart
- Parameters:
- header- a- Stringgiving the name of the MIME header(s) to be removed
 
 - 
removeAllMimeHeaderspublic void removeAllMimeHeaders() Removes all theMimeHeaderobjects for thisSOAPEnvelopeobject.- Specified by:
- removeAllMimeHeadersin class- SOAPPart
 
 - 
getMimeHeaderpublic String[] getMimeHeader(String name) Gets all the values of theMimeHeaderobject in thisSOAPPartobject that is identified by the givenString.- Specified by:
- getMimeHeaderin class- SOAPPart
- Parameters:
- name- the name of the header; example: "Content-Type"
- Returns:
- a Stringarray giving all the values for the specified header
- See Also:
- setMimeHeader(java.lang.String, java.lang.String)
 
 - 
setMimeHeaderpublic void setMimeHeader(String name, String value) Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match. If there is a match, this method clears all existing values for the first header that matches and sets the given value instead. If more than one header has the given name, this method removes all of the matching headers after the first one.Note that RFC822 headers can contain only US-ASCII characters. - Specified by:
- setMimeHeaderin class- SOAPPart
- Parameters:
- name- a- Stringgiving the header name for which to search
- value- a- Stringgiving the value to be set. This value will be substituted for the current value(s) of the first header that is a match if there is one. If there is no match, this value will be the value for a new- MimeHeaderobject.
- Throws:
- IllegalArgumentException- if there was a problem with the specified mime header name or value
- IllegalArgumentException- if there was a problem with the specified mime header name or value
- See Also:
- getMimeHeader(java.lang.String)
 
 - 
addMimeHeaderpublic void addMimeHeader(String header, String value) Creates aMimeHeaderobject with the specified name and value and adds it to thisSOAPPartobject. If aMimeHeaderwith the specified name already exists, this method adds the specified value to the already existing value(s).Note that RFC822 headers can contain only US-ASCII characters. - Specified by:
- addMimeHeaderin class- SOAPPart
- Parameters:
- header- a- Stringgiving the header name
- value- a- Stringgiving the value to be set or added
- Throws:
- IllegalArgumentException- if there was a problem with the specified mime header name or value
 
 - 
getAllMimeHeaderspublic Iterator getAllMimeHeaders() Retrieves all the headers for thisSOAPPartobject as an iterator over theMimeHeaderobjects.- Specified by:
- getAllMimeHeadersin class- SOAPPart
- Returns:
- an Iteratorobject with all of the Mime headers for thisSOAPPartobject
 
 - 
getMatchingMimeHeaderspublic Iterator getMatchingMimeHeaders(String[] names) Retrieves allMimeHeaderobjects that match a name in the given array.- Specified by:
- getMatchingMimeHeadersin class- SOAPPart
- Parameters:
- names- a- Stringarray with the name(s) of the MIME headers to be returned
- Returns:
- all of the MIME headers that match one of the names in the given array, returned as
         an Iteratorobject
 
 - 
getNonMatchingMimeHeaderspublic Iterator getNonMatchingMimeHeaders(String[] names) Retrieves allMimeHeaderobjects whose name does not match a name in the given array.- Specified by:
- getNonMatchingMimeHeadersin class- SOAPPart
- Parameters:
- names- a- Stringarray with the name(s) of the MIME headers not to be returned
- Returns:
- all of the MIME headers in this SOAPPartobject except those that match one of the names in the given array. The nonmatching MIME headers are returned as anIteratorobject.
 
 - 
setContentpublic void setContent(Source source) throws SOAPException - Specified by:
- setContentin class- SOAPPart
- Throws:
- SOAPException
 
 - 
getContentpublic Source getContent() throws SOAPException Returns the content of the SOAPEnvelope as a JAXPSourceobject.- Specified by:
- getContentin class- SOAPPart
- Returns:
- the content as a javax.xml.transform.Sourceobject
- Throws:
- SOAPException- if the implementation cannot convert the specified- Sourceobject
- See Also:
- setContent(javax.xml.transform.Source)
 
 - 
getDoctypepublic DocumentType getDoctype() The Document Type Declaration (seeDocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returnsnull. The DOM Level 2 does not support editing the Document Type Declaration.docTypecannot be altered in any way, including through the use of methods inherited from theNodeinterface, such asinsertNodeorremoveNode.
 - 
getImplementationpublic DOMImplementation getImplementation() TheDOMImplementationobject that handles this document. A DOM application may use objects from multiple implementations.
 - 
getDocumentElementpublic Element getDocumentElement() This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".
 - 
createElementpublic Element createElement(String tagName) throws DOMException Creates an element of the type specified. Note that the instance returned implements theElementinterface, so attributes can be specified directly on the returned object.
 In addition, if there are known attributes with default values,Attrnodes representing them are automatically created and attached to the element.
 To create an element with a qualified name and namespace URI, use thecreateElementNSmethod.- Parameters:
- tagName- The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the- tagNameparameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.
- Returns:
- A new Elementobject with thenodeNameattribute set totagName, andlocalName,prefix, andnamespaceURIset tonull.
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
 
 - 
createDocumentFragmentpublic DocumentFragment createDocumentFragment() Creates an emptyDocumentFragmentobject.- Returns:
- A new DocumentFragment.
 
 - 
createTextNodepublic Text createTextNode(String data) Creates aTextnode given the specified string.- Parameters:
- data- The data for the node.
- Returns:
- The new Textobject.
 
 - 
createCommentpublic Comment createComment(String data) Creates aCDATASectionnode whose value is the specified string.- Parameters:
- data- The data for the- CDATASectioncontents.
- Returns:
- The new CDATASectionobject.
- Throws:
- DOMException- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
 
 - 
createCDATASectionpublic CDATASection createCDATASection(String data) throws DOMException Creates aCDATASectionnode whose value is the specified string.- Parameters:
- data- The data for the- CDATASectioncontents.
- Returns:
- The new CDATASectionobject.
- Throws:
- DOMException- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
 
 - 
createProcessingInstructionpublic ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException Creates aProcessingInstructionnode given the specified name and data strings.- Parameters:
- target- The target part of the processing instruction.
- data- The data for the node.
- Returns:
- The new ProcessingInstructionobject.
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
 NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
 
 - 
createAttributepublic Attr createAttribute(String name) throws DOMException Creates anAttrof the given name. Note that theAttrinstance can then be set on anElementusing thesetAttributeNodemethod.
 To create an attribute with a qualified name and namespace URI, use thecreateAttributeNSmethod.- Parameters:
- name- The name of the attribute.
- Returns:
- A new Attrobject with thenodeNameattribute set toname, andlocalName,prefix, andnamespaceURIset tonull. The value of the attribute is the empty string.
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
 
 - 
createEntityReferencepublic EntityReference createEntityReference(String name) throws DOMException Creates anEntityReferenceobject. In addition, if the referenced entity is known, the child list of theEntityReferencenode is made the same as that of the correspondingEntitynode.If any descendant of theEntitynode has an unbound namespace prefix, the corresponding descendant of the createdEntityReferencenode is also unbound; (itsnamespaceURIisnull). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.- Parameters:
- name- The name of the entity to reference.
- Returns:
- The new EntityReferenceobject.
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
 NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
 
 - 
getElementsByTagNamepublic NodeList getElementsByTagName(String tagname) Returns aNodeListof all theElementswith a given tag name in the order in which they are encountered in a preorder traversal of theDocumenttree.- Parameters:
- tagname- The name of the tag to match on. The special value "*" matches all tags.
- Returns:
- A new NodeListobject containing all the matchedElements.
 
 - 
importNodepublic Node importNode(Node importedNode, boolean deep) throws DOMException Imports a node from another document to this document. The returned node has no parent; (parentNodeisnull). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
 For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node'snodeNameandnodeType, plus the attributes related to namespaces (prefix,localName, andnamespaceURI). As in thecloneNodeoperation on aNode, the source node is not altered.
 Additional information is copied as appropriate to thenodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.- ATTRIBUTE_NODE
- The
 ownerElementattribute is set tonulland thespecifiedflag is set totrueon the generatedAttr. The descendants of the sourceAttrare recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that thedeepparameter has no effect onAttrnodes; they always carry their children with them when imported.
- DOCUMENT_FRAGMENT_NODE
- If the deepoption was set totrue, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an emptyDocumentFragment.
- DOCUMENT_NODE
- Documentnodes cannot be imported.
- DOCUMENT_TYPE_NODE
- DocumentTypenodes cannot be imported.
- ELEMENT_NODE
- Specified attribute nodes of the source element are imported, and the generated
 Attrnodes are attached to the generatedElement. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If theimportNodedeepparameter was set totrue, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
- ENTITY_NODE
- Entitynodes can be imported, however in the current release of the DOM the- DocumentTypeis readonly. Ability to add these imported nodes to a- DocumentTypewill be considered for addition to a future release of the DOM.On import, the- publicId,- systemId, and- notationNameattributes are copied. If a- deepimport is requested, the descendants of the the source- Entityare recursively imported and the resulting nodes reassembled to form the corresponding subtree.
- ENTITY_REFERENCE_NODE
- Only the EntityReferenceitself is copied, even if adeepimport is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
- NOTATION_NODE
-  Notationnodes can be imported, however in the current release of the DOM theDocumentTypeis readonly. Ability to add these imported nodes to aDocumentTypewill be considered for addition to a future release of the DOM.On import, thepublicIdandsystemIdattributes are copied. Note that thedeepparameter has no effect onNotationnodes since they never have any children.
- PROCESSING_INSTRUCTION_NODE
- The
 imported node copies its targetanddatavalues from those of the source node.
- TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
- These three types
 of nodes inheriting from CharacterDatacopy theirdataandlengthattributes from those of the source node.
 - Parameters:
- importedNode- The node to import.
- deep- If- true, recursively import the subtree under the specified node; if- false, import only the node itself, as explained above. This has no effect on- Attr,- EntityReference, and- Notationnodes.
- Returns:
- The imported node that belongs to this Document.
- Throws:
- DOMException- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
- Since:
- DOM Level 2
 
 - 
createElementNSpublic Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException Creates an element of the given qualified name and namespace URI.- Parameters:
- namespaceURI- The namespace URI of the element to create.
- qualifiedName- The qualified name of the element type to instantiate.
- Returns:
- A new Elementobject with the following attributes:Attribute Value Node.nodeNamequalifiedNameNode.namespaceURInamespaceURINode.prefixprefix, extracted from qualifiedName, ornullif there is no prefixNode.localNamelocal name, extracted from qualifiedNameElement.tagNamequalifiedName
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
 NAMESPACE_ERR: Raised if the- qualifiedNameis malformed per the Namespaces in XML specification, if the- qualifiedNamehas a prefix and the- namespaceURIis- null, or if the- qualifiedNamehas a prefix that is "xml" and the- namespaceURIis different from " http://www.w3.org/XML/1998/namespace" .
 NOT_SUPPORTED_ERR: Always thrown if the current document does not support the- "XML"feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
 
 - 
createAttributeNSpublic Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException Creates an attribute of the given qualified name and namespace URI.- Parameters:
- namespaceURI- The namespace URI of the attribute to create.
- qualifiedName- The qualified name of the attribute to instantiate.
- Returns:
- A new Attrobject with the following attributes:Attribute Value Node.nodeNamequalifiedName Node.namespaceURInamespaceURINode.prefixprefix, extracted from qualifiedName, ornullif there is no prefixNode.localNamelocal name, extracted from qualifiedNameAttr.namequalifiedNameNode.nodeValuethe empty string 
- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
 NAMESPACE_ERR: Raised if the- qualifiedNameis malformed per the Namespaces in XML specification, if the- qualifiedNamehas a prefix and the- namespaceURIis- null, if the- qualifiedNamehas a prefix that is "xml" and the- namespaceURIis different from " http://www.w3.org/XML/1998/namespace", or if the- qualifiedName, or its prefix, is "xmlns" and the- namespaceURIis different from " http://www.w3.org/2000/xmlns/".
 NOT_SUPPORTED_ERR: Always thrown if the current document does not support the- "XML"feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
 
 - 
getElementsByTagNameNSpublic NodeList getElementsByTagNameNS(String namespaceURI, String localName) Returns aNodeListof all theElementswith a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocumenttree.- Parameters:
- namespaceURI- The namespace URI of the elements to match on. The special value "*" matches all namespaces.
- localName- The local name of the elements to match on. The special value "*" matches all local names.
- Returns:
- A new NodeListobject containing all the matchedElements.
- Since:
- DOM Level 2
 
 - 
getElementByIdpublic Element getElementById(String elementId) Returns theElementwhoseIDis given byelementId. If no such element exists, returnsnull. Behavior is not defined if more than one element has thisID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to returnnull.- Parameters:
- elementId- The unique- idvalue for an element.
- Returns:
- The matching element.
- Since:
- DOM Level 2
 
 - 
getInputEncodingpublic String getInputEncoding() 
 - 
getXmlEncodingpublic String getXmlEncoding() 
 - 
getXmlStandalonepublic boolean getXmlStandalone() 
 - 
setXmlStandalonepublic void setXmlStandalone(boolean xmlStandalone) throws DOMException- Throws:
- DOMException
 
 - 
getXmlVersionpublic String getXmlVersion() 
 - 
setXmlVersionpublic void setXmlVersion(String xmlVersion) throws DOMException - Throws:
- DOMException
 
 - 
getStrictErrorCheckingpublic boolean getStrictErrorChecking() 
 - 
setStrictErrorCheckingpublic void setStrictErrorChecking(boolean strictErrorChecking) 
 - 
getDocumentURIpublic String getDocumentURI() 
 - 
setDocumentURIpublic void setDocumentURI(String documentURI) 
 - 
adoptNodepublic Node adoptNode(Node source) throws DOMException - Throws:
- DOMException
 
 - 
getDomConfigpublic DOMConfiguration getDomConfig() 
 - 
normalizeDocumentpublic void normalizeDocument() 
 - 
renameNodepublic Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException - Throws:
- DOMException
 
 - 
getNodeNamepublic String getNodeName() The name of this node, depending on its type; see the table above.
 - 
getNodeValuepublic String getNodeValue() throws DOMException The value of this node, depending on its type; see the table above. When it is defined to benull, setting it has no effect.- Throws:
- DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
- DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a- DOMStringvariable on the implementation platform.
 
 - 
setNodeValuepublic void setNodeValue(String arg0) throws DOMException The value of this node, depending on its type; see the table above. When it is defined to benull, setting it has no effect.- Throws:
- DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
- DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a- DOMStringvariable on the implementation platform.
 
 - 
getNodeTypepublic short getNodeType() A code representing the type of the underlying object, as defined above.
 - 
getParentNodepublic Node getParentNode() The parent of this node. All nodes, exceptAttr,Document,DocumentFragment,Entity, andNotationmay have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this isnull.
 - 
getChildNodespublic NodeList getChildNodes() ANodeListthat contains all children of this node. If there are no children, this is aNodeListcontaining no nodes.
 - 
getFirstChildpublic Node getFirstChild() The first child of this node. If there is no such node, this returnsnull.
 - 
getLastChildpublic Node getLastChild() The last child of this node. If there is no such node, this returnsnull.
 - 
getPreviousSiblingpublic Node getPreviousSibling() The node immediately preceding this node. If there is no such node, this returnsnull.
 - 
getNextSiblingpublic Node getNextSibling() The node immediately following this node. If there is no such node, this returnsnull.
 - 
getAttributespublic NamedNodeMap getAttributes() ANamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.
 - 
getOwnerDocumentpublic Document getOwnerDocument() TheDocumentobject associated with this node. This is also theDocumentobject used to create new nodes. When this node is aDocumentor aDocumentTypewhich is not used with anyDocumentyet, this isnull.
 - 
insertBeforepublic Node insertBefore(Node newChild, Node refChild) throws DOMException Inserts the nodenewChildbefore the existing child noderefChild. IfrefChildisnull, insertnewChildat the end of the list of children.
 IfnewChildis aDocumentFragmentobject, all of its children are inserted, in the same order, beforerefChild. If thenewChildis already in the tree, it is first removed.- Parameters:
- newChild- The node to insert.
- refChild- The reference node, i.e., the node before which the new node must be inserted.
- Returns:
- The node being inserted.
- Throws:
- DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the- newChildnode, or if the node to insert is one of this node's ancestors or this node itself.
 WRONG_DOCUMENT_ERR: Raised if- newChildwas created from a different document than the one that created this node.
 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
 NOT_FOUND_ERR: Raised if- refChildis not a child of this node.
 
 - 
replaceChildpublic Node replaceChild(Node newChild, Node oldChild) throws DOMException Replaces the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode.
 IfnewChildis aDocumentFragmentobject,oldChildis replaced by all of theDocumentFragmentchildren, which are inserted in the same order. If thenewChildis already in the tree, it is first removed.- Parameters:
- newChild- The new node to put in the child list.
- oldChild- The node being replaced in the list.
- Returns:
- The node replaced.
- Throws:
- DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the- newChildnode, or if the node to put in is one of this node's ancestors or this node itself.
 WRONG_DOCUMENT_ERR: Raised if- newChildwas created from a different document than the one that created this node.
 NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
 NOT_FOUND_ERR: Raised if- oldChildis not a child of this node.
 
 - 
removeChildpublic Node removeChild(Node oldChild) throws DOMException Removes the child node indicated byoldChildfrom the list of children, and returns it.- Parameters:
- oldChild- The node being removed.
- Returns:
- The node removed.
- Throws:
- DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
 NOT_FOUND_ERR: Raised if- oldChildis not a child of this node.
 
 - 
appendChildpublic Node appendChild(Node newChild) throws DOMException Adds the nodenewChildto the end of the list of children of this node. If thenewChildis already in the tree, it is first removed.- Parameters:
- newChild- The node to add.If it is a- DocumentFragmentobject, the entire contents of the document fragment are moved into the child list of this node
- Returns:
- The node added.
- Throws:
- DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the- newChildnode, or if the node to append is one of this node's ancestors or this node itself.
 WRONG_DOCUMENT_ERR: Raised if- newChildwas created from a different document than the one that created this node.
 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
 
 - 
hasChildNodespublic boolean hasChildNodes() Returns whether this node has any children.- Returns:
- trueif this node has any children,- falseotherwise.
 
 - 
cloneNodepublic Node cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; (parentNodeisnull.).
 Cloning anElementcopies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a childTextnode. Cloning anAttributedirectly, as opposed to be cloned as part of anElementcloning operation, returns a specified attribute (specifiedistrue). Cloning any other type of node simply returns a copy of this node.
 Note that cloning an immutable subtree results in a mutable copy, but the children of anEntityReferenceclone are readonly . In addition, clones of unspecifiedAttrnodes are specified. And, cloningDocument,DocumentType,Entity, andNotationnodes is implementation dependent.- Parameters:
- deep- If- true, recursively clone the subtree under the specified node; if- false, clone only the node itself (and its attributes, if it is an- Element).
- Returns:
- The duplicate node.
 
 - 
normalizepublic void normalize() Puts allTextnodes in the full depth of the sub-tree underneath thisNode, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.In cases where the document containsCDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenTextnodes andCDATASectionnodes.
 - 
isSupportedpublic boolean isSupported(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.- Parameters:
- feature- The name of the feature to test. This is the same name which can be passed to the method- hasFeatureon- DOMImplementation.
- version- This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return- true.
- Returns:
- Returns trueif the specified feature is supported on this node,falseotherwise.
- Since:
- DOM Level 2
 
 - 
getNamespaceURIpublic String getNamespaceURI() The namespace URI of this node, ornullif it is unspecified.
 This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
 For nodes of any type other thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull.Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.- Since:
- DOM Level 2
 
 - 
getPrefixpublic String getPrefix() The namespace prefix of this node, ornullif it is unspecified.
 Note that setting this attribute, when permitted, changes thenodeNameattribute, which holds the qualified name, as well as thetagNameandnameattributes of theElementandAttrinterfaces, when applicable.
 Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURIandlocalNamedo not change.
 For nodes of any type other thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull.- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
 NAMESPACE_ERR: Raised if the specified- prefixis malformed per the Namespaces in XML specification, if the- namespaceURIof this node is- null, if the specified prefix is "xml" and the- namespaceURIof this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the- namespaceURIof this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the- qualifiedNameof this node is "xmlns" .
- Since:
- DOM Level 2
 
 - 
setPrefixpublic void setPrefix(String arg0) throws DOMException The namespace prefix of this node, ornullif it is unspecified.
 Note that setting this attribute, when permitted, changes thenodeNameattribute, which holds the qualified name, as well as thetagNameandnameattributes of theElementandAttrinterfaces, when applicable.
 Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURIandlocalNamedo not change.
 For nodes of any type other thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull.- Throws:
- DOMException- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
 NAMESPACE_ERR: Raised if the specified- prefixis malformed per the Namespaces in XML specification, if the- namespaceURIof this node is- null, if the specified prefix is "xml" and the- namespaceURIof this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the- namespaceURIof this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the- qualifiedNameof this node is "xmlns" .
- Since:
- DOM Level 2
 
 - 
getLocalNamepublic String getLocalName() Returns the local part of the qualified name of this node.
 For nodes of any type other thanELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDocumentinterface, this is alwaysnull.- Since:
- DOM Level 2
 
 - 
hasAttributespublic boolean hasAttributes() Returns whether this node (if it is an element) has any attributes.- Returns:
- trueif this node has any attributes,- falseotherwise.
- Since:
- DOM Level 2
 
 - 
setMessageprotected void setMessage(SOAPMessageImpl message) 
 - 
getBaseURIpublic String getBaseURI() 
 - 
compareDocumentPositionpublic short compareDocumentPosition(Node node) throws DOMException - Throws:
- DOMException
 
 - 
getTextContentpublic String getTextContent() throws DOMException - Throws:
- DOMException
 
 - 
setTextContentpublic void setTextContent(String textContent) throws DOMException - Throws:
- DOMException
 
 - 
isSameNodepublic boolean isSameNode(Node other) 
 - 
isDefaultNamespacepublic boolean isDefaultNamespace(String namespaceURI) 
 - 
isEqualNodepublic boolean isEqualNode(Node node) 
 - 
setUserDatapublic Object setUserData(String key, Object data, UserDataHandler handler) 
 - 
getValuepublic String getValue() 
 - 
setParentElementpublic void setParentElement(SOAPElement parent) throws SOAPException - Throws:
- SOAPException
 
 - 
getParentElementpublic SOAPElement getParentElement() 
 - 
detachNodepublic void detachNode() 
 - 
recycleNodepublic void recycleNode() 
 - 
setValuepublic void setValue(String value) 
 
- 
 
-