Class 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. 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
Author:
Michael H. Kay
  • Constructor Details

    • CommentStripper

      public CommentStripper(Receiver next)
      Default constructor for use in subclasses
      Parameters:
      next - the next receiver in the pipeline
  • Method Details

    • startElement

      public void startElement(NodeName nameCode, SchemaType typeCode, int locationId, 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:
      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.
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - properties of the element node
      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(CharSequence chars, int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      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(CharSequence chars, int locationId, int properties)
      Remove comments
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      Parameters:
      chars - The content of the comment
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Additional information about the comment.
    • processingInstruction

      public void processingInstruction(String name, CharSequence data, int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Additional information about the PI.