OpenJDK 27 · org.w3c.dom.traversal.DocumentTraversal

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public NodeIterator	Returns: The newly created `NodeIterator`. createNodeIterator(Node The node which will be iterated together with its children. The `NodeIterator` is initially positioned just before this node. The `whatToShow` flags and the filter, if any, are not considered when setting this position. The root must not be `null`. root, int This flag specifies which node types may appear in the logical view of the tree presented by the `NodeIterator`. See the description of `NodeFilter` for the set of possible `SHOW_` values.These flags can be combined using `OR`. whatToShow, NodeFilter The `NodeFilter` to be used with this `NodeIterator`, or `null` to indicate no filter. filter, boolean The value of this flag determines whether entity reference nodes are expanded. entityReferenceExpansion) Create a new `NodeIterator` over the subtree rooted at the specified node.
public TreeWalker	Returns: The newly created `TreeWalker`. createTreeWalker(Node The node which will serve as the `root` for the `TreeWalker`. The `whatToShow` flags and the `NodeFilter` are not considered when setting this value; any node type will be accepted as the `root`. The `currentNode` of the `TreeWalker` is initialized to this node, whether or not it is visible. The `root` functions as a stopping point for traversal methods that look upward in the document structure, such as `parentNode` and nextNode. The `root` must not be `null`. root, int This flag specifies which node types may appear in the logical view of the tree presented by the `TreeWalker`. See the description of `NodeFilter` for the set of possible `SHOW_` values.These flags can be combined using `OR`. whatToShow, NodeFilter The `NodeFilter` to be used with this `TreeWalker`, or `null` to indicate no filter. filter, boolean If this flag is false, the contents of `EntityReference` nodes are not presented in the logical view. entityReferenceExpansion) Create a new `TreeWalker` over the subtree rooted at the specified node.

Returns:

The newly created NodeIterator.

The node which will be iterated together with its children. The NodeIterator is initially positioned just before this node. The whatToShow flags and the filter, if any, are not considered when setting this position. The root must not be null.

root, int

This flag specifies which node types may appear in the logical view of the tree presented by the NodeIterator. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.

whatToShow, NodeFilter

The NodeFilter to be used with this NodeIterator, or null to indicate no filter.

filter, boolean

The value of this flag determines whether entity reference nodes are expanded.

entityReferenceExpansion)

Create a new NodeIterator over the subtree rooted at the specified node.

public TreeWalker

Returns:

The newly created TreeWalker.

createTreeWalker(Node

The node which will serve as the root for the TreeWalker. The whatToShow flags and the NodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the TreeWalker is initialized to this node, whether or not it is visible. The root functions as a stopping point for traversal methods that look upward in the document structure, such as parentNode and nextNode. The root must not be null.

root, int

This flag specifies which node types may appear in the logical view of the tree presented by the TreeWalker. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.

whatToShow, NodeFilter

The NodeFilter to be used with this TreeWalker, or null to indicate no filter.

filter, boolean

If this flag is false, the contents of EntityReference nodes are not presented in the logical view.

entityReferenceExpansion)

Create a new TreeWalker over the subtree rooted at the specified node.

Method Detail

createNodeIterator back to summary

createNodeIterator	back to summary
public NodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException Create a new `NodeIterator` over the subtree rooted at the specified node. Parameters root:Node The node which will be iterated together with its children. The `NodeIterator` is initially positioned just before this node. The `whatToShow` flags and the filter, if any, are not considered when setting this position. The root must not be `null`. whatToShow:int This flag specifies which node types may appear in the logical view of the tree presented by the `NodeIterator`. See the description of `NodeFilter` for the set of possible `SHOW_` values.These flags can be combined using `OR`. filter:NodeFilter The `NodeFilter` to be used with this `NodeIterator`, or `null` to indicate no filter. entityReferenceExpansion:boolean The value of this flag determines whether entity reference nodes are expanded. Returns:NodeIterator The newly created `NodeIterator`. Exceptions DOMException: NOT_SUPPORTED_ERR: Raised if the specified `root` is `null`.

public NodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException

Create a new NodeIterator over the subtree rooted at the specified node.

Parameters

root:Node: The node which will be iterated together with its children. The NodeIterator is initially positioned just before this node. The whatToShow flags and the filter, if any, are not considered when setting this position. The root must not be null.
whatToShow:int: This flag specifies which node types may appear in the logical view of the tree presented by the NodeIterator. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.
filter:NodeFilter: The NodeFilter to be used with this NodeIterator, or null to indicate no filter.
entityReferenceExpansion:boolean: The value of this flag determines whether entity reference nodes are expanded.

Returns:NodeIterator

The newly created NodeIterator.

Exceptions

DOMException:: NOT_SUPPORTED_ERR: Raised if the specified root is null.

createTreeWalker back to summary

createTreeWalker	back to summary
public TreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException Create a new `TreeWalker` over the subtree rooted at the specified node. Parameters root:Node The node which will serve as the `root` for the `TreeWalker`. The `whatToShow` flags and the `NodeFilter` are not considered when setting this value; any node type will be accepted as the `root`. The `currentNode` of the `TreeWalker` is initialized to this node, whether or not it is visible. The `root` functions as a stopping point for traversal methods that look upward in the document structure, such as `parentNode` and nextNode. The `root` must not be `null`. whatToShow:int This flag specifies which node types may appear in the logical view of the tree presented by the `TreeWalker`. See the description of `NodeFilter` for the set of possible `SHOW_` values.These flags can be combined using `OR`. filter:NodeFilter The `NodeFilter` to be used with this `TreeWalker`, or `null` to indicate no filter. entityReferenceExpansion:boolean If this flag is false, the contents of `EntityReference` nodes are not presented in the logical view. Returns:TreeWalker The newly created `TreeWalker`. Exceptions DOMException: NOT_SUPPORTED_ERR: Raised if the specified `root` is `null`.

public TreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException