public interface Document extends Node
Document interface represents the entire HTML or XML
 document. Conceptually, it is the root of the document tree, and provides
 the primary access to the document's data.
 Since elements, text nodes, comments, processing instructions, etc.
 cannot exist outside the context of a Document, the
 Document interface also contains the factory methods needed
 to create these objects. The Node objects created have a
 ownerDocument attribute which associates them with the
 Document within whose context they were created.
 
See also the Document Object Model (DOM) Level 3 Core Specification.
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| Modifier and Type | Method and Description | 
|---|---|
| Node | adoptNode(Node source)Attempts to adopt a node from another document to this document. | 
| Attr | createAttribute(String name)Creates an  Attrof the given name. | 
| Attr | createAttributeNS(String namespaceURI,
                 String qualifiedName)Creates an attribute of the given qualified name and namespace URI. | 
| CDATASection | createCDATASection(String data)Creates a  CDATASectionnode whose value is the specified
 string. | 
| Comment | createComment(String data)Creates a  Commentnode given the specified string. | 
| DocumentFragment | createDocumentFragment()Creates an empty  DocumentFragmentobject. | 
| Element | createElement(String tagName)Creates an element of the type specified. | 
| Element | createElementNS(String namespaceURI,
               String qualifiedName)Creates an element of the given qualified name and namespace URI. | 
| EntityReference | createEntityReference(String name)Creates an  EntityReferenceobject. | 
| ProcessingInstruction | createProcessingInstruction(String target,
                           String data)Creates a  ProcessingInstructionnode given the specified
 name and data strings. | 
| Text | createTextNode(String data)Creates a  Textnode given the specified string. | 
| DocumentType | getDoctype()The Document Type Declaration (see  DocumentType)
 associated with this document. | 
| Element | getDocumentElement()This is a convenience attribute that allows direct access to the child
 node that is the document element of the document. | 
| String | getDocumentURI()The location of the document or  nullif undefined or if
 theDocumentwas created usingDOMImplementation.createDocument. | 
| DOMConfiguration | getDomConfig()The configuration used when  Document.normalizeDocument()is invoked. | 
| Element | getElementById(String elementId)Returns the  Elementthat has an ID attribute with the
 given value. | 
| NodeList | getElementsByTagName(String tagname)Returns a  NodeListof all theElementsin
 document order with a given tag name and are contained in the
 document. | 
| NodeList | getElementsByTagNameNS(String namespaceURI,
                      String localName)Returns a  NodeListof all theElementswith a
 given local name and namespace URI in document order. | 
| DOMImplementation | getImplementation()The  DOMImplementationobject that handles this document. | 
| String | getInputEncoding()An attribute specifying the encoding used for this document at the time
 of the parsing. | 
| boolean | getStrictErrorChecking()An attribute specifying whether error checking is enforced or not. | 
| String | getXmlEncoding()An attribute specifying, as part of the XML declaration, the encoding of this document. | 
| boolean | getXmlStandalone()An attribute specifying, as part of the XML declaration, whether this document is standalone. | 
| String | getXmlVersion()An attribute specifying, as part of the XML declaration, the version number of this document. | 
| Node | importNode(Node importedNode,
          boolean deep)Imports a node from another document to this document, without altering
 or removing the source node from the original document; this method
 creates a new copy of the source node. | 
| void | normalizeDocument()This method acts as if the document was going through a save and load
 cycle, putting the document in a "normal" form. | 
| Node | renameNode(Node n,
          String namespaceURI,
          String qualifiedName)Rename an existing node of type  ELEMENT_NODEorATTRIBUTE_NODE. | 
| void | setDocumentURI(String documentURI)The location of the document or  nullif undefined or if
 theDocumentwas created usingDOMImplementation.createDocument. | 
| void | setStrictErrorChecking(boolean strictErrorChecking)An attribute specifying whether error checking is enforced or not. | 
| void | setXmlStandalone(boolean xmlStandalone)An attribute specifying, as part of the XML declaration, whether this document is standalone. | 
| void | setXmlVersion(String xmlVersion)An attribute specifying, as part of the XML declaration, the version number of this document. | 
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, setUserDataDocumentType getDoctype()
DocumentType)
 associated with this document. For XML documents without a document
 type declaration this returns null. For HTML documents,
 a DocumentType object may be returned, independently of
 the presence or absence of document type declaration in the HTML
 document.
 DocumentType node,
 child node of this Document. This node can be set at
 document creation time and later changed through the use of child
 nodes manipulation methods, such as Node.insertBefore,
 or Node.replaceChild. Note, however, that while some
 implementations may instantiate different types of
 Document objects supporting additional features than the
 "Core", such as "HTML" [DOM Level 2 HTML]
 , based on the DocumentType specified at creation time,
 changing it afterwards is very unlikely to result in a change of the
 features supported.DOMImplementation getImplementation()
DOMImplementation object that handles this document. A
 DOM application may use objects from multiple implementations.Element getDocumentElement()
Element createElement(String tagName) throws DOMException
Element interface, so attributes
 can be specified directly on the returned object.
 Attr nodes representing them are automatically created
 and attached to the element.
 createElementNS method.tagName - The name of the element type to instantiate. For XML,
   this is case-sensitive, otherwise it depends on the
   case-sensitivity of the markup language in use. In that case, the
   name is mapped to the canonical form of that markup by the DOM
   implementation.Element object with the
   nodeName attribute set to tagName, and
   localName, prefix, and
   namespaceURI set to null.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
   name according to the XML version in use specified in the
   Document.xmlVersion attribute.DocumentFragment createDocumentFragment()
DocumentFragment object.DocumentFragment.Text createTextNode(String data)
Text node given the specified string.data - The data for the node.Text object.Comment createComment(String data)
Comment node given the specified string.data - The data for the node.Comment object.CDATASection createCDATASection(String data) throws DOMException
CDATASection node whose value is the specified
 string.data - The data for the CDATASection contents.CDATASection object.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException
ProcessingInstruction node given the specified
 name and data strings.target - The target part of the processing instruction.Unlike
   Document.createElementNS or
   Document.createAttributeNS, no namespace well-formed
   checking is done on the target name. Applications should invoke
   Document.normalizeDocument() with the parameter "
   namespaces" set to true in order to ensure that the
   target name is namespace well-formed.data - The data for the node.ProcessingInstruction object.DOMException - INVALID_CHARACTER_ERR: Raised if the specified target is not an XML
   name according to the XML version in use specified in the
   Document.xmlVersion attribute.
   Attr createAttribute(String name) throws DOMException
Attr of the given name. Note that the
 Attr instance can then be set on an Element
 using the setAttributeNode method.
 createAttributeNS method.name - The name of the attribute.Attr object with the nodeName
   attribute set to name, and localName,
   prefix, and namespaceURI set to
   null. The value of the attribute is the empty string.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
   name according to the XML version in use specified in the
   Document.xmlVersion attribute.EntityReference createEntityReference(String name) throws DOMException
EntityReference object. In addition, if the
 referenced entity is known, the child list of the
 EntityReference node is made the same as that of the
 corresponding Entity node.
 Note: If any descendant of the Entity node has
 an unbound namespace prefix, the corresponding descendant of the
 created EntityReference node is also unbound; (its
 namespaceURI is null). The DOM Level 2 and
 3 do not support any mechanism to resolve namespace prefixes in this
 case.
name - The name of the entity to reference.Unlike
   Document.createElementNS or
   Document.createAttributeNS, no namespace well-formed
   checking is done on the entity name. Applications should invoke
   Document.normalizeDocument() with the parameter "
   namespaces" set to true in order to ensure that the
   entity name is namespace well-formed.EntityReference object.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
   name according to the XML version in use specified in the
   Document.xmlVersion attribute.
   NodeList getElementsByTagName(String tagname)
NodeList of all the Elements in
 document order with a given tag name and are contained in the
 document.tagname - The name of the tag to match on. The special value "*"
   matches all tags. For XML, the tagname parameter is
   case-sensitive, otherwise it depends on the case-sensitivity of the
   markup language in use.NodeList object containing all the matched
   Elements.Node importNode(Node importedNode, boolean deep) throws DOMException
parentNode is null).
 nodeName and nodeType, plus the
 attributes related to namespaces (prefix,
 localName, and namespaceURI). As in the
 cloneNode operation, the source node is not altered.
 User data associated to the imported node is not carried over.
 However, if any UserDataHandlers has been specified
 along with the associated data these handlers will be called with the
 appropriate parameters before this method returns.
 nodeType, 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.
 ownerElement attribute
 is set to null and the specified flag is
 set to true on the generated Attr. The
 descendants of the source Attr are recursively imported
 and the resulting nodes reassembled to form the corresponding subtree.
 Note that the deep parameter has no effect on
 Attr nodes; they always carry their children with them
 when imported.deep option
 was set to true, the descendants of the source
 DocumentFragment are recursively imported and the
 resulting nodes reassembled under the imported
 DocumentFragment to form the corresponding subtree.
 Otherwise, this simply generates an empty
 DocumentFragment.Document
 nodes cannot be imported.DocumentType
 nodes cannot be imported.Attr nodes are attached to the generated
 Element. Default attributes are not copied, though if the document being imported into defines default
 attributes for this element name, those are assigned. If the
 importNode deep parameter was set to
 true, the descendants of the source element are
 recursively imported and the resulting nodes reassembled to form the
 corresponding subtree.Entity nodes can be
 imported, however in the current release of the DOM the
 DocumentType is readonly. Ability to add these imported
 nodes to a DocumentType will be considered for addition
 to a future release of the DOM.On import, the publicId,
 systemId, and notationName attributes are
 copied. If a deep import is requested, the descendants
 of the the source Entity are recursively imported and
 the resulting nodes reassembled to form the corresponding subtree.EntityReference itself is
 copied, even if a deep import 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 nodes can be imported, however in the current
 release of the DOM the DocumentType is readonly. Ability
 to add these imported nodes to a DocumentType will be
 considered for addition to a future release of the DOM.On import, the
 publicId and systemId attributes are copied.
 Note that the deep parameter has no effect on this type
 of nodes since they cannot have any children.target and data values from those of the
 source node.Note that the deep parameter has no effect
 on this type of nodes since they cannot have any children.CharacterData copy their data and
 length attributes from those of the source node.Note
 that the deep parameter has no effect on these types of
 nodes since they cannot have any children.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 nodes that cannot
   have any children, and on Attr, and
   EntityReference nodes.Document.DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
   supported.
   Document.xmlVersion attribute. This may happen when
   importing an XML 1.1 [XML 1.1] element
   into an XML 1.0 document, for instance.Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException
null as the
 namespaceURI parameter for methods if they wish to have no namespace.namespaceURI - The namespace URI of the element to create.qualifiedName - The qualified name of the element type to
   instantiate.Element object with the following
   attributes:
 | Attribute | Value | 
|---|---|
| Node.nodeName | qualifiedName | 
| Node.namespaceURI | namespaceURI | 
| Node.prefix | prefix, extracted
   from qualifiedName, ornullif there is
   no prefix | 
| Node.localName | local name, extracted from qualifiedName | 
| Element.tagName | qualifiedName | 
DOMException - INVALID_CHARACTER_ERR: Raised if the specified
   qualifiedName is not an XML name according to the XML
   version in use specified in the Document.xmlVersion
   attribute.
   qualifiedName is a
   malformed qualified name, if the qualifiedName has a
   prefix and the namespaceURI is null, or
   if the qualifiedName has a prefix that is "xml" and
   the namespaceURI is different from "
   http://www.w3.org/XML/1998/namespace" [XML Namespaces]
   , or if the qualifiedName or its prefix is "xmlns" and
   the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
   "XML" feature, since namespaces were
   defined by XML.Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException
null as the
 namespaceURI parameter for methods if they wish to have
 no namespace.namespaceURI - The namespace URI of the attribute to create.qualifiedName - The qualified name of the attribute to
   instantiate.Attr object with the following attributes:
 | Attribute | Value | 
|---|---|
| Node.nodeName | qualifiedName | 
| Node.namespaceURI | namespaceURI | 
| Node.prefix | prefix, extracted from qualifiedName, ornullif there is no
   prefix | 
| Node.localName | local name, extracted from qualifiedName | 
| Attr.name | qualifiedName | 
| Node.nodeValue | the empty string | 
DOMException - INVALID_CHARACTER_ERR: Raised if the specified
   qualifiedName is not an XML name according to the XML
   version in use specified in the Document.xmlVersion
   attribute.
   qualifiedName is a
   malformed qualified name, if the qualifiedName has a
   prefix and the namespaceURI is null, if
   the qualifiedName has a prefix that is "xml" and the
   namespaceURI is different from "
   http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is "xmlns" and the
   namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
   "XML" feature, since namespaces were
   defined by XML.NodeList getElementsByTagNameNS(String namespaceURI, String localName)
NodeList of all the Elements with a
 given local name and namespace URI in document order.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.NodeList object containing all the matched
   Elements.Element getElementById(String elementId)
Element that has an ID attribute with the
 given value. If no such element exists, this returns null
 . If more than one element has an ID attribute with that value, what
 is returned is undefined.
 Attr.isId to determine if an attribute is of type ID.
 Note: Attributes with the name "ID" or "id" are not of type ID unless so defined.
elementId - The unique id value for an element.null if there is none.String getInputEncoding()
null when it is not known, such
 as when the Document was created in memory.String getXmlEncoding()
null when
 unspecified or when it is not known, such as when the
 Document was created in memory.boolean getXmlStandalone()
false when
 unspecified.
 Note:  No verification is done on the value when setting
 this attribute. Applications should use
 Document.normalizeDocument() with the "validate"
 parameter to verify if the value matches the validity
 constraint for standalone document declaration as defined in [XML 1.0].
void setXmlStandalone(boolean xmlStandalone)
               throws DOMException
false when
 unspecified.
 Note:  No verification is done on the value when setting
 this attribute. Applications should use
 Document.normalizeDocument() with the "validate"
 parameter to verify if the value matches the validity
 constraint for standalone document declaration as defined in [XML 1.0].
DOMException - NOT_SUPPORTED_ERR: Raised if this document does not support the
   "XML" feature.String getXmlVersion()
"1.0". If this document does not support the "XML"
 feature, the value is always null. Changing this
 attribute will affect methods that check for invalid characters in
 XML names. Application should invoke
 Document.normalizeDocument() in order to check for
 invalid characters in the Nodes that are already part of
 this Document.
 DOMImplementation.hasFeature(feature, version) method
 with parameter values "XMLVersion" and "1.0" (respectively) to
 determine if an implementation supports [XML 1.0]. DOM
 applications may use the same method with parameter values
 "XMLVersion" and "1.1" (respectively) to determine if an
 implementation supports [XML 1.1]. In both
 cases, in order to support XML, an implementation must also support
 the "XML" feature defined in this specification. Document
  objects supporting a version of the "XMLVersion" feature must not
 raise a NOT_SUPPORTED_ERR exception for the same version
 number when using Document.xmlVersion.void setXmlVersion(String xmlVersion) throws DOMException
"1.0". If this document does not support the "XML"
 feature, the value is always null. Changing this
 attribute will affect methods that check for invalid characters in
 XML names. Application should invoke
 Document.normalizeDocument() in order to check for
 invalid characters in the Nodes that are already part of
 this Document.
 DOMImplementation.hasFeature(feature, version) method
 with parameter values "XMLVersion" and "1.0" (respectively) to
 determine if an implementation supports [XML 1.0]. DOM
 applications may use the same method with parameter values
 "XMLVersion" and "1.1" (respectively) to determine if an
 implementation supports [XML 1.1]. In both
 cases, in order to support XML, an implementation must also support
 the "XML" feature defined in this specification. Document
  objects supporting a version of the "XMLVersion" feature must not
 raise a NOT_SUPPORTED_ERR exception for the same version
 number when using Document.xmlVersion.DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is
   not supported by this Document or if this document
   does not support the "XML" feature.boolean getStrictErrorChecking()
false, the implementation is free to not test
 every possible error case normally defined on DOM operations, and not
 raise any DOMException on DOM operations or report
 errors while using Document.normalizeDocument(). In case
 of error, the behavior is undefined. This attribute is
 true by default.void setStrictErrorChecking(boolean strictErrorChecking)
false, the implementation is free to not test
 every possible error case normally defined on DOM operations, and not
 raise any DOMException on DOM operations or report
 errors while using Document.normalizeDocument(). In case
 of error, the behavior is undefined. This attribute is
 true by default.String getDocumentURI()
null if undefined or if
 the Document was created using
 DOMImplementation.createDocument. No lexical checking is
 performed when setting this attribute; this could result in a
 null value returned when using Node.baseURI
 .
 Document supports the feature
 "HTML" [DOM Level 2 HTML]
 , the href attribute of the HTML BASE element takes precedence over
 this attribute when computing Node.baseURI.void setDocumentURI(String documentURI)
null if undefined or if
 the Document was created using
 DOMImplementation.createDocument. No lexical checking is
 performed when setting this attribute; this could result in a
 null value returned when using Node.baseURI
 .
 Document supports the feature
 "HTML" [DOM Level 2 HTML]
 , the href attribute of the HTML BASE element takes precedence over
 this attribute when computing Node.baseURI.Node adoptNode(Node source) throws DOMException
ownerDocument of the source
 node, its children, as well as the attached attribute nodes if there
 are any. If the source node has a parent it is first removed from the
 child list of its parent. This effectively allows moving a subtree
 from one document to another (unlike importNode() which
 create a copy of the source node instead of moving it). When it
 fails, applications should use Document.importNode()
 instead. Note that if the adopted node is already part of this
 document (i.e. the source and target document are the same), this
 method still has the effect of removing the source node from the
 child list of its parent, if any. The following list describes the
 specifics for each type of node.
 ownerElement attribute is set to null and
 the specified flag is set to true on the
 adopted Attr. The descendants of the source
 Attr are recursively adopted.Document nodes cannot be adopted.DocumentType nodes cannot be adopted.Entity nodes cannot be adopted.EntityReference node itself is adopted, the
 descendants are discarded, 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 nodes cannot be
 adopted.Note:  Since it does not create new nodes unlike the
 Document.importNode() method, this method does not raise
 an INVALID_CHARACTER_ERR exception, and applications
 should use the Document.normalizeDocument() method to
 check if an imported name is not an XML name according to the XML
 version in use.
source - The node to move into this document.null if this operation
   fails, such as when the source node comes from a different
   implementation.DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type
   DOCUMENT, DOCUMENT_TYPE.
   DOMConfiguration getDomConfig()
Document.normalizeDocument()
 is invoked.void normalizeDocument()
EntityReference nodes and normalizes Text
 nodes, as defined in the method Node.normalize().
 Document.domConfig object and governing what
 operations actually take place. Noticeably this method could also
 make the document namespace well-formed according to the algorithm
 described in , check the character normalization, remove the
 CDATASection nodes, etc. See
 DOMConfiguration for details.
 // Keep in the document
 the information defined // in the XML Information Set (Java example)
 DOMConfiguration docConfig = myDocument.getDomConfig();
 docConfig.setParameter("infoset", Boolean.TRUE);
 myDocument.normalizeDocument();
 Node.nodeName
 contains an invalid character according to the XML version in use,
 errors or warnings (DOMError.SEVERITY_ERROR or
 DOMError.SEVERITY_WARNING) will be reported using the
 DOMErrorHandler object associated with the "error-handler
 " parameter. Note this method might also report fatal errors (
 DOMError.SEVERITY_FATAL_ERROR) if an implementation
 cannot recover from an error.Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException
ELEMENT_NODE or
 ATTRIBUTE_NODE.
 Element its
 attributes are moved to the new node, the new node is inserted at the
 position the old node used to have in its parent's child nodes list
 if it has one, the user data that was attached to the old node is
 attached to the new node.
 Element only the
 specified attributes are moved, default attributes originated from
 the DTD are updated according to the new element name. In addition,
 the implementation may update default attributes from other schemas.
 Applications should use Document.normalizeDocument() to
 guarantee these attributes are up-to-date.
 Attr that is
 attached to an Element, the node is first removed from
 the Element attributes map. Then, once renamed, either
 by modifying the existing node or creating a new one as described
 above, it is put back.
 NODE_RENAMED is fired,
 http://www.w3.org/2001/xml-events,
 DOMElementNameChanged} or {
 http://www.w3.org/2001/xml-events,
 DOMAttributeNameChanged} is fired.
 n - The node to rename.namespaceURI - The new namespace URI.qualifiedName - The new qualified name.DOMException - NOT_SUPPORTED_ERR: Raised when the type of the specified node is
   neither ELEMENT_NODE nor ATTRIBUTE_NODE,
   or if the implementation does not support the renaming of the
   document element.
   Document.xmlVersion attribute.
   qualifiedName is a
   malformed qualified name, if the qualifiedName has a
   prefix and the namespaceURI is null, or
   if the qualifiedName has a prefix that is "xml" and
   the namespaceURI is different from "
   http://www.w3.org/XML/1998/namespace" [XML Namespaces]
   . Also raised, when the node being renamed is an attribute, if the
   qualifiedName, or its prefix, is "xmlns" and the
   namespaceURI is different from "http://www.w3.org/2000/xmlns/". Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
 Copyright © 2005, 2025, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.