Package org.jsoup.nodes

Class Comment

java.lang.Object

org.jsoup.nodes.Node

org.jsoup.nodes.Comment

All Implemented Interfaces:

Cloneable

public class Comment
extends Node

A comment node.

Author:

Jonathan Hedley, jonathan@hedley.net

Constructor Summary

Constructors

Constructor	Description
Comment(String data)	Create a new comment node.
Comment(String data, String baseUri)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	absUrl(String key)	Get an absolute URL from a URL attribute that may be relative (i.e.
String	attr(String key)	Get an attribute's value by its key.
Node	attr(String key, String value)	Set an attribute (key=value).
Attributes	attributes()	Get all of the element's attributes.
String	baseUri()	Get the base URI of this node.
int	childNodeSize()	Get the number of child nodes that this node holds.
protected void	doSetBaseUri(String baseUri)	Set the baseUri for just this node (not its descendants), if this Node tracks base URIs.
protected List<Node>	ensureChildNodes()
String	getData()	Get the contents of the comment.
boolean	hasAttr(String key)	Test if this element has an attribute.
protected boolean	hasAttributes()	Check if this Node has an actual Attributes object.
String	nodeName()	Get the node name of this node.
Node	removeAttr(String key)	Remove an attribute from this element.
String	toString()

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, outerHtml, outerHtml, ownerDocument, parent, parentNode, previousSibling, remove, removeChild, reparentChild, replaceChild, replaceWith, root, setBaseUri, setParentNode, setSiblingIndex, shallowClone, siblingIndex, siblingNodes, traverse, unwrap, wrap

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

public Comment(String data)

Create a new comment node.

Parameters:

data - The contents of the comment

Comment

public Comment(String data,
               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 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 String getData()

Get the contents of the comment.

Returns:

comment content

toString

public String toString()

Overrides:

toString in class Node

hasAttributes

protected final boolean hasAttributes()

Description copied from class: Node

Check if this Node has an actual Attributes object.

Specified by:

hasAttributes in class Node

attributes

public final Attributes attributes()

Description copied from class: Node

Get all of the element's attributes.

Specified by:

attributes in class Node

Returns:

attributes (which implements iterable, in same order as presented in original HTML).

attr

public String attr(String key)

Description copied from class: Node

Get an attribute's value by its key. Case insensitive

To get an absolute URL from an attribute that may be a relative URL, prefix the key with abs, which is a shortcut to the Node.absUrl(java.lang.String) method.

E.g.:

String url = a.attr("abs:href");

Overrides:

attr in class Node

Parameters:

key - The attribute key.

Returns:

The attribute, or empty string if not present (to avoid nulls).

See Also:

Node.attributes(), Node.hasAttr(String), Node.absUrl(String)

attr

public Node attr(String key,
                 String value)

Description copied from class: Node

Set an attribute (key=value). If the attribute already exists, it is replaced. The attribute key comparison is case insensitive.

Overrides:

attr in class Node

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

this (for chaining)

hasAttr

public boolean hasAttr(String key)

Description copied from class: Node

Test if this element has an attribute. Case insensitive

Overrides:

hasAttr in class Node

Parameters:

key - The attribute key to check.

Returns:

true if the attribute exists, false if not.

removeAttr

public Node removeAttr(String key)

Description copied from class: Node

Remove an attribute from this element.

Overrides:

removeAttr in class Node

Parameters:

key - The attribute to remove.

Returns:

this (for chaining)

absUrl

public String absUrl(String key)

Description copied from class: Node

Get an absolute URL from a URL attribute that may be relative (i.e. an <a href> or <img src>).

E.g.: String absUrl = linkEl.absUrl("href");

If the attribute value is already absolute (i.e. it starts with a protocol, like http:// or https:// etc), and it successfully parses as a URL, the attribute is returned directly. Otherwise, it is treated as a URL relative to the element's Node.baseUri(), and made absolute using that.

As an alternate, you can use the Node.attr(java.lang.String) method with the abs: prefix, e.g.: String absUrl = linkEl.attr("abs:href");

Overrides:

absUrl in class Node

Parameters:

key - The attribute key

Returns:

An absolute URL if one could be made, or an empty string (not null) if the attribute was missing or could not be made successfully into a URL.

See Also:

Node.attr(java.lang.String), URL(java.net.URL, String)

baseUri

public String baseUri()

Description copied from class: Node

Get the base URI of this node.

Specified by:

baseUri in class Node

Returns:

base URI

doSetBaseUri

protected void doSetBaseUri(String baseUri)

Description copied from class: Node

Set the baseUri for just this node (not its descendants), if this Node tracks base URIs.

Specified by:

doSetBaseUri in class Node

Parameters:

baseUri - new URI

childNodeSize

public int childNodeSize()

Description copied from class: Node

Get the number of child nodes that this node holds.

Specified by:

childNodeSize in class Node

Returns:

the number of child nodes that this node holds.

ensureChildNodes

protected List<Node> ensureChildNodes()

Specified by:

ensureChildNodes in class Node