NodeFilter JDK 1.6)

Description

public interface NodeFilter

Filters are objects that know how to "filter out" nodes.

Filters are objects that know how to "filter out" nodes. If a NodeIterator or TreeWalker is given a NodeFilter, it applies the filter before it returns the next node. If the filter says to accept the node, the traversal logic returns it; otherwise, traversal looks for the next node and pretends that the node that was rejected was not there.

The DOM does not provide any filters. NodeFilter is just an interface that users can implement to provide their own filters.

NodeFilters do not need to know how to traverse from node to node, nor do they need to know anything about the data structure that is being traversed. This makes it very easy to write filters, since the only thing they have to know how to do is evaluate a single node. One filter may be used with a number of different kinds of traversals, encouraging code reuse.

See also:

Fields

Hide/Show inherited fields

publicfinalstatic short FILTER_ACCEPT = "1"

Accept the node.

Accept the node. Navigation methods defined for
NodeIterator or TreeWalker will return this
node.

publicfinalstatic short FILTER_REJECT = "2"

Reject the node.

Reject the node. Navigation methods defined for
NodeIterator or TreeWalker will not return
this node. For TreeWalker, the children of this node
will also be rejected. NodeIterators treat this as a
synonym for FILTER_SKIP.

publicfinalstatic short FILTER_SKIP = "3"

Skip this single node.

Skip this single node. Navigation methods defined for
NodeIterator or TreeWalker will not return
this node. For both NodeIterator and
TreeWalker, the children of this node will still be
considered.

publicfinalstatic int SHOW_ALL = "-1"

Show all Nodes.

publicfinalstatic int SHOW_ATTRIBUTE = "2"

Show Attr nodes.

Show Attr nodes. This is meaningful only when creating an
NodeIterator or TreeWalker with an
attribute node as its root; in this case, it means that
the attribute node will appear in the first position of the iteration
or traversal. Since attributes are never children of other nodes,
they do not appear when traversing over the document tree.

publicfinalstatic int SHOW_CDATA_SECTION = "8"

Show CDATASection nodes.

publicfinalstatic int SHOW_COMMENT = "128"

Show Comment nodes.

publicfinalstatic int SHOW_DOCUMENT = "256"

Show Document nodes.

publicfinalstatic int SHOW_DOCUMENT_FRAGMENT = "1024"

Show DocumentFragment nodes.

publicfinalstatic int SHOW_DOCUMENT_TYPE = "512"

Show DocumentType nodes.

publicfinalstatic int SHOW_ELEMENT = "1"

Show Element nodes.

publicfinalstatic int SHOW_ENTITY = "32"

Show Entity nodes.

Show Entity nodes. This is meaningful only when creating
an NodeIterator or TreeWalker with an
Entity node as its root; in this case, it
means that the Entity node will appear in the first
position of the traversal. Since entities are not part of the
document tree, they do not appear when traversing over the document
tree.

publicfinalstatic int SHOW_ENTITY_REFERENCE = "16"

Show EntityReference nodes.

publicfinalstatic int SHOW_NOTATION = "2048"

Show Notation nodes.

Show Notation nodes. This is meaningful only when creating
an NodeIterator or TreeWalker with a
Notation node as its root; in this case, it
means that the Notation node will appear in the first
position of the traversal. Since notations are not part of the
document tree, they do not appear when traversing over the document
tree.

publicfinalstatic int SHOW_PROCESSING_INSTRUCTION = "64"

Show ProcessingInstruction nodes.

publicfinalstatic int SHOW_TEXT = "4"

Show Text nodes.