Interface Document

  • All Superinterfaces:
    Node

    public interface Document
    extends Node
    Document objects represent XML documents. Each Document can contain exactly one Element node, and any number of other node types.
    • Method Detail

      • createCDATASection

        CDATASection createCDATASection​(java.lang.String data)
        This method creates a new CDATASection.
        Parameters:
        data - the data of the new CDATASection
        Returns:
        the newly created CDATASection
      • createComment

        Comment createComment​(java.lang.String data)
        This method creates a new Comment.
        Parameters:
        data - the data of the new Comment
        Returns:
        the newly created Comment
      • createDocumentFragment

        DocumentFragment createDocumentFragment()
        This method creates a new DocumentFragment.
        Returns:
        the newly created DocumentFragment
      • createElement

        Element createElement​(java.lang.String tagName)
        This method creates a new Element.
        Parameters:
        tagName - the tag name of the new Element
        Returns:
        the newly created Element
      • createProcessingInstruction

        ProcessingInstruction createProcessingInstruction​(java.lang.String target,
                                                          java.lang.String data)
        This method creates a new ProcessingInstruction.
        Parameters:
        target - the target of the new ProcessingInstruction
        data - the data of the new ProcessingInstruction
        Returns:
        the newly created ProcessingInstruction
      • createTextNode

        Text createTextNode​(java.lang.String data)
        This method creates a new Text.
        Parameters:
        data - the data of the new Text
        Returns:
        the newly created Text
      • getDocumentElement

        Element getDocumentElement()
        This method retrieves the document element. Each document has at most one Element as its direct child, and this node is returned if it exists. null is returned otherwise.
        Returns:
        the document element of this Document
      • getElementById

        Element getElementById​(java.lang.String elementId)
        This method retrieves the unique descendent elements which has an id of elementId. Note the attribute which is used as an ID must be supplied in the DTD of the document. It is not sufficient to give the Element to be retrieved an attribute named 'id'.
        Returns:
        the Element which has an id of elementId and belongs to this Document
      • getElementsByTagName

        NodeList getElementsByTagName​(java.lang.String tagname)
        This method retrieves any descendent elements which have a tag name of tagname.
        Returns:
        the NodeList of elements which has a tag name of tagname and belong to this Document
      • importNode

        Node importNode​(Node importedNode,
                        boolean deep)
        This method imports a node into the current Document.
        Parameters:
        deep - whether to recurse to children
        Returns:
        the node Node imported