Package net.sf.saxon.event

Class CommentStripper

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.event.CommentStripper

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class CommentStripper
extends ProxyReceiver

The CommentStripper class is a filter that removes all comments and processing instructions. It also concatenates text nodes that are split by comments and PIs. This follows the rules for processing stylesheets; it is also used for removing comments and PIs from the tree seen by XPath expressions used to process XSD 1.1 assertions.

It also has the ability to deep-skip xsl:note (or any other) elements, as required for XSLT 4.0.

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor	Description
CommentStripper(Receiver next)	Default constructor for use in subclasses

Method Summary

Modifier and Type	Method	Description
void	characters(UnicodeString chars, Location locationId, int properties)	Handle a text node.
void	comment(UnicodeString chars, Location locationId, int properties)	Remove comments
void	endElement()	Callback interface for SAX: not for application use
void	processingInstruction(java.lang.String name, UnicodeString data, Location locationId, int properties)	Remove processing instructions
void	setSkippedElementTest(java.util.function.Predicate<NodeName> test)
void	startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)	Notify the start of an element

Methods inherited from class net.sf.saxon.event.ProxyReceiver

append, close, endDocument, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument, usesTypeAnnotations

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentStripper

public CommentStripper(Receiver next)

Default constructor for use in subclasses

Parameters:

next - the next receiver in the pipeline

Method Detail

setSkippedElementTest

public void setSkippedElementTest(java.util.function.Predicate<NodeName> test)

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException

Description copied from class: ProxyReceiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

attributes - the attributes of this element

namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

endElement

public void endElement()
                throws XPathException

Callback interface for SAX: not for application use

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException - if an error occurs

characters

public void characters(UnicodeString chars,
                       Location locationId,
                       int properties)
                throws XPathException

Handle a text node. Because we're often handling stylesheets on this path, whitespace text nodes will often be stripped but we can't strip them immediately because of the case [element] [!-- comment --]text[/element], where the space before the comment is considered significant. But it's worth going to some effort to avoid uncompressing the whitespace in the more common case, so that it can easily be detected and stripped downstream.

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

Throws:

XPathException - if an error occurs

comment

public void comment(UnicodeString chars,
                    Location locationId,
                    int properties)

Remove comments

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - provides information such as line number and system ID.

properties - Additional information about the comment.

processingInstruction

public void processingInstruction(java.lang.String name,
                                  UnicodeString data,
                                  Location locationId,
                                  int properties)

Remove processing instructions

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

name - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

locationId - provides information such as line number and system ID.

properties - Additional information about the PI.