Package org.jsoup.nodes
Class Comment
- java.lang.Object
-
- org.jsoup.nodes.Node
-
- org.jsoup.nodes.LeafNode
-
- org.jsoup.nodes.Comment
-
- All Implemented Interfaces:
java.lang.Cloneable
public class Comment extends LeafNode
A comment node.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
COMMENT_KEY
-
Fields inherited from class org.jsoup.nodes.Node
EmptyString, parentNode, siblingIndex
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XmlDeclaration
asXmlDeclaration()
Attempt to cast this comment to an XML Declaration note.java.lang.String
getData()
Get the contents of the comment.boolean
isXmlDeclaration()
Check if this comment looks like an XML Declaration.java.lang.String
nodeName()
Get the node name of this node.(package private) void
outerHtmlHead(java.lang.Appendable accum, int depth, Document.OutputSettings out)
Get the outer HTML of this node.(package private) void
outerHtmlTail(java.lang.Appendable accum, int depth, Document.OutputSettings out)
java.lang.String
toString()
Gets this node's outer HTML.-
Methods inherited from class org.jsoup.nodes.LeafNode
absUrl, attr, attr, attributes, baseUri, childNodeSize, coreValue, coreValue, doSetBaseUri, ensureChildNodes, hasAttr, hasAttributes, removeAttr
-
Methods inherited from class org.jsoup.nodes.Node
addChildren, addChildren, after, after, before, before, childNode, childNodes, childNodesAsArray, childNodesCopy, clearAttributes, clone, doClone, equals, filter, hasParent, hasSameValue, html, indent, nextSibling, nodelistChanged, outerHtml, outerHtml, ownerDocument, parent, parentNode, previousSibling, remove, removeChild, reparentChild, replaceChild, replaceWith, root, setBaseUri, setParentNode, setSiblingIndex, shallowClone, siblingIndex, siblingNodes, traverse, unwrap, wrap
-
-
-
-
Field Detail
-
COMMENT_KEY
private static final java.lang.String COMMENT_KEY
- See Also:
- Constant Field Values
-
-
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 commentbaseUri
- 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).
-
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 classNode
- Parameters:
accum
- accumulator to place HTML into- Throws:
java.io.IOException
- if appending to the given accumulator fails.
-
outerHtmlTail
void outerHtmlTail(java.lang.Appendable accum, int depth, Document.OutputSettings out)
- Specified by:
outerHtmlTail
in classNode
-
toString
public java.lang.String toString()
Description copied from class:Node
Gets this node's outer HTML.- Overrides:
toString
in classNode
- 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.
-
-