Package org.jsoup.select
Interface NodeVisitor
- All Known Implementing Classes:
W3CDom.W3CBuilder
public interface NodeVisitor
Node visitor interface. Provide an implementing class to
NodeTraversor
to iterate through nodes.
This interface provides two methods, head
and tail
. The head method is called when the node is first
seen, and the tail method when all of the node's children have been visited. As an example, head
can be used to
emit a start tag for a node, and tail
to create the end tag.
-
Method Summary
-
Method Details
-
head
Callback for when a node is first visited.The node may be modified (e.g.
Node.attr(String)
, replacedNode.replaceWith(Node)
) or removedNode.remove()
. If it'sinstanceOf Element
, you may cast it to anElement
and access those methods.- Parameters:
node
- the node being visited.depth
- the depth of the node, relative to the root node. E.g., the root node has depth 0, and a child node of that will have depth 1.
-
tail
Callback for when a node is last visited, after all of its descendants have been visited.This method has a default no-op implementation.
Note that neither replacement with
Node.replaceWith(Node)
nor removal withNode.remove()
is supported duringtail()
.- Parameters:
node
- the node being visited.depth
- the depth of the node, relative to the root node. E.g., the root node has depth 0, and a child node of that will have depth 1.
-