Class Comment

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class Comment
    extends LeafNode
    A comment node.
    • Constructor Detail

      • Comment

        public Comment​(java.lang.String data)
        Create a new comment node.
        Parameters:
        data - The contents of the comment
    • Method Detail

      • nodeName

        public java.lang.String nodeName()
        Description copied from class: Node
        Get the node name of this node. Use for debugging purposes and not logic switching (for that, use instanceof).
        Specified by:
        nodeName in class Node
        Returns:
        node name
      • getData

        public java.lang.String getData()
        Get the contents of the comment.
        Returns:
        comment content
      • setData

        public Comment setData​(java.lang.String data)
      • outerHtmlHead

        void outerHtmlHead​(java.lang.Appendable accum,
                           int depth,
                           Document.OutputSettings out)
                    throws java.io.IOException
        Description copied from class: Node
        Get the outer HTML of this node.
        Specified by:
        outerHtmlHead in class Node
        Parameters:
        accum - accumulator to place HTML into
        Throws:
        java.io.IOException - if appending to the given accumulator fails.
      • toString

        public java.lang.String toString()
        Description copied from class: Node
        Gets this node's outer HTML.
        Overrides:
        toString in class Node
        Returns:
        outer HTML.
        See Also:
        Node.outerHtml()
      • clone

        public java.lang.Object clone()
        Description copied from class: Node
        Create a stand-alone, deep copy of this node, and all of its children. The cloned node will have no siblings or parent node. As a stand-alone object, any changes made to the clone or any of its children will not impact the original node.

        The cloned node may be adopted into another Document or node structure using Element.appendChild(Node).

        Overrides:
        clone in class Node
        Returns:
        a stand-alone cloned node, including clones of any children
        See Also:
        Node.shallowClone()
      • isXmlDeclaration

        public boolean isXmlDeclaration()
        Check if this comment looks like an XML Declaration.
        Returns:
        true if it looks like, maybe, it's an XML Declaration.
      • isXmlDeclarationData

        private static boolean isXmlDeclarationData​(java.lang.String data)
      • asXmlDeclaration

        public XmlDeclaration asXmlDeclaration()
        Attempt to cast this comment to an XML Declaration node.
        Returns:
        an XML declaration if it could be parsed as one, null otherwise.