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
      • Comment

        public Comment​(java.lang.String data,
                       java.lang.String baseUri)
        Deprecated.
        Create a new comment node.
        Parameters:
        data - The contents of the comment
        baseUri - base URI not used. This is a leaf node.
    • 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
      • 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()
      • 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.
      • asXmlDeclaration

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