Package org.jsoup.nodes

Class Printer

java.lang.Object

org.jsoup.nodes.Printer

All Implemented Interfaces:

NodeVisitor

Direct Known Subclasses:

Printer.Pretty

class Printer
extends Object
implements NodeVisitor

Base Printer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Printer.Outline	Outline Printer
(package private) static class	Printer.Pretty	Pretty Printer

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final QuietAppendable	accum
(package private) final Node	root
(package private) final Document.OutputSettings	settings

Constructor Summary

Constructors

Constructor	Description
Printer(Node root, QuietAppendable accum, Document.OutputSettings settings)

Method Summary

Modifier and Type	Method	Description
(package private) void	addHead(Element el, int depth)
(package private) void	addNode(LeafNode node, int depth)
(package private) void	addTail(Element el, int depth)
(package private) void	addText(TextNode textNode, int textOptions, int depth)
void	head(Node node, int depth)	Callback for when a node is first visited.
(package private) void	indent(int depth)
(package private) static Printer	printerFor(Node root, QuietAppendable accum)
void	tail(Node node, int depth)	Callback for when a node is last visited, after all of its descendants have been visited.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jsoup.select.NodeVisitor

traverse

Field Details

root

final Node root

accum

final QuietAppendable accum

settings

final Document.OutputSettings settings

Constructor Details

Printer

Printer(Node root,
 QuietAppendable accum,
 Document.OutputSettings settings)

Method Details

addHead

void addHead(Element el,
 int depth)

addTail

void addTail(Element el,
 int depth)

addText

void addText(TextNode textNode,
 int textOptions,
 int depth)

addNode

void addNode(LeafNode node,
 int depth)

indent

void indent(int depth)

head

public void head(Node node,
 int depth)

Description copied from interface: NodeVisitor

Callback for when a node is first visited.

The node may be modified (for example via Node.attr(String)), removed with Node.remove(), or replaced with Node.replaceWith(Node). If the node is an Element, you may cast it and access those methods.

Traversal uses a forward cursor. After head() completes:

• If the current node is still attached, traversal continues into its current children and then its following siblings. Nodes inserted before the current node are not visited.
• If the current node was detached and another node now occupies its former sibling position, the node now at that position is not passed to head() again. Traversal continues from there: its children are visited, then the node is passed to NodeVisitor.tail(Node, int), then later siblings are visited.
• If the current node was detached and no node occupies its former sibling position, the current node is not passed to tail(), and traversal resumes at the node that originally followed it.

Traversal never advances outside the original root subtree. If the traversal root is detached during head(), traversal stops at the original root boundary.

Specified by:

head in interface NodeVisitor

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

public void tail(Node node,
 int depth)

Description copied from interface: NodeVisitor

Callback for when a node is last visited, after all of its descendants have been visited.

This method defaults to a no-op.

The node passed to tail() is the node at the current traversal position when the subtree completes. If head() replaced the original node, this may be the replacement node instead.

Structural changes to the current node are not supported during tail().

Specified by:

tail in interface NodeVisitor

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.

printerFor

static Printer printerFor(Node root,
 QuietAppendable accum)