org.jsoup.nodes.Node;

[zatramanh56789]

package org.jsoup.select;

import org.jsoup.nodes.Node;

/**

• Node filter interface. Provide an implementing class to {@link NodeTraversor} to iterate through nodes.
• This interface provides two methods, {@code head} and {@code 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
• create a start tag for a node, and tail to create the end tag.
• For every node, the filter has to decide whether to:
• continue ({@link FilterResult#CONTINUE}),
• skip all children ({@link FilterResult#SKIP_CHILDREN}),
• skip node entirely ({@link FilterResult#SKIP_ENTIRELY}),
• remove the subtree ({@link FilterResult#REMOVE}),
• interrupt the iteration and return ({@link FilterResult#STOP}).

The difference between {@link FilterResult#SKIP_CHILDREN} and {@link FilterResult#SKIP_ENTIRELY} is that the first

will invoke {@link NodeFilter#tail(Node, int)} on the node, while the latter will not.

Within {@link NodeFilter#tail(Node, int)}, both are equivalent to {@link FilterResult#CONTINUE}.

/ public interface NodeFilter { /* * Filter decision. / enum FilterResult { /* Continue processing the tree / CONTINUE, /* Skip the child nodes, but do call {@link NodeFilter#tail(Node, int)} next. / SKIP_CHILDREN, /* Skip the subtree, and do not call {@link NodeFilter#tail(Node, int)}. / SKIP_ENTIRELY, /* Remove the node and its children / REMOVE, /* Stop processing */ STOP }

/**
 * Callback for when a node is first visited.
 * @param node the node being visited.
 * @param 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.
 * @return Filter decision
 */
FilterResult head(Node node, int depth);

/**
 * Callback for when a node is last visited, after all of its descendants have been visited.
 * <p>This method has a default implementation to return {@link FilterResult#CONTINUE}.</p>
 * @param node the node being visited.
 * @param 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.
 * @return Filter decision
 */
default FilterResult tail(Node node, int depth) {
    return FilterResult.CONTINUE;
}

}