net.sf.saxon.event
Class CommentStripper

java.lang.Object
  net.sf.saxon.event.ProxyReceiver
      net.sf.saxon.event.CommentStripper

All Implemented Interfaces:

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

Author:

Michael H. Kay (michael.h.kay@ntlworld.com)

Field Summary

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

baseReceiver, namePool, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

CommentStripper()
Default constructor for use in subclasses

Method Summary

void	characters(CharSequence chars, int properties) Callback interface for SAX: not for application use
void	comment(CharSequence chars, int properties) Remove comments
void	endElement() Callback interface for SAX: not for application use
void	processingInstruction(String name, CharSequence data, int properties) Remove processing instructions
void	startElement(int nameCode, int typeCode, int properties) Notify the start of an element

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

attribute, endDocument, getNamePool, getSystemId, getUnderlyingReceiver, namespace, setDocumentLocator, setNamePool, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentStripper

public CommentStripper()

Default constructor for use in subclasses

Method Detail

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws TransformerException

Description copied from class: ProxyReceiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

nameCode - integer code identifying the name of the element within the name pool.

typeCode - integer code identifying the element's type within the name pool.

Throws:

TransformerException

endElement

public void endElement()
                throws TransformerException

Callback interface for SAX: not for application use

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException

Callback interface for SAX: not for application use

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

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

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

TransformerException

comment

public void comment(CharSequence chars,
                    int properties)

Remove comments

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

properties - Additional information about the comment. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

processingInstruction

public void processingInstruction(String name,
                                  CharSequence data,
                                  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

properties - Additional information about the PI. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")