LSSerializerFilter JDK 1.6)

Description

public interface LSSerializerFilter

LSSerializerFilters provide applications the ability to examine nodes as they are being serialized and decide what nodes should be serialized or not.

LSSerializerFilters provide applications the ability to examine nodes as they are being serialized and decide what nodes should be serialized or not. The LSSerializerFilter interface is based on the NodeFilter interface defined in [DOM Level 2 Traversal and Range] .

Document, DocumentType, DocumentFragment, Notation, Entity , and children of Attr nodes are not passed to the filter. The child nodes of an EntityReference node are only passed to the filter if the EntityReference node is skipped by the method LSParserFilter.acceptNode().

When serializing an Element, the element is passed to the filter before any of its attributes are passed to the filter. Namespace declaration attributes, and default attributes (except in the case when " discard-default-content" is set to false), are never passed to the filter.

The result of any attempt to modify a node passed to a LSSerializerFilter is implementation dependent.

DOM applications must not raise exceptions in a filter. The effect of throwing exceptions from a filter is DOM implementation dependent.

For efficiency, a node passed to the filter may not be the same as the one that is actually in the tree. And the actual node (node object identity) may be reused during the process of filtering and serializing a document.

See also:

Methods

Hide/Show inherited methods

public int getWhatToShow ()

Tells the LSSerializer what types of nodes to show to the filter.

Tells the LSSerializer what types of nodes to show to the
filter. If a node is not shown to the filter using this attribute, it
is automatically serialized. See NodeFilter for
definition of the constants. The constants SHOW_DOCUMENT
, SHOW_DOCUMENT_TYPE, SHOW_DOCUMENT_FRAGMENT
, SHOW_NOTATION, and SHOW_ENTITY are
meaningless here, such nodes will never be passed to a
LSSerializerFilter.

Unlike [DOM Level 2 Traversal and Range]
, the SHOW_ATTRIBUTE constant indicates that the
Attr nodes are shown and passed to the filter.

The constants used here are defined in [DOM Level 2 Traversal and Range]
.

Fields

Hide/Show inherited fields

publicfinalstatic short FILTER_ACCEPT = "1" [Inherited From NodeFilter]

Accept the node.

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

publicfinalstatic short FILTER_REJECT = "2" [Inherited From NodeFilter]

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" [Inherited From NodeFilter]

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" [Inherited From NodeFilter]

Show all Nodes.

publicfinalstatic int SHOW_ATTRIBUTE = "2" [Inherited From NodeFilter]

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" [Inherited From NodeFilter]

Show CDATASection nodes.

publicfinalstatic int SHOW_COMMENT = "128" [Inherited From NodeFilter]

Show Comment nodes.

publicfinalstatic int SHOW_DOCUMENT = "256" [Inherited From NodeFilter]

Show Document nodes.

publicfinalstatic int SHOW_DOCUMENT_FRAGMENT = "1024" [Inherited From NodeFilter]

Show DocumentFragment nodes.

publicfinalstatic int SHOW_DOCUMENT_TYPE = "512" [Inherited From NodeFilter]

Show DocumentType nodes.

publicfinalstatic int SHOW_ELEMENT = "1" [Inherited From NodeFilter]

Show Element nodes.

publicfinalstatic int SHOW_ENTITY = "32" [Inherited From NodeFilter]

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" [Inherited From NodeFilter]

Show EntityReference nodes.

publicfinalstatic int SHOW_NOTATION = "2048" [Inherited From NodeFilter]

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" [Inherited From NodeFilter]

Show ProcessingInstruction nodes.

publicfinalstatic int SHOW_TEXT = "4" [Inherited From NodeFilter]

Show Text nodes.