Package net.sf.saxon.event

Class EventMonitor

java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.event.EventMonitor
All Implemented Interfaces:
Result, Receiver
public class EventMonitor extends ProxyReceiver
An EventMonitor is a filter that passes all events down the pipeline unchanged, keeping a note of whether any data has passed through the filter. At any stage it is possible to ask whether any data has been written.
Since:
9.9

  • Field Details

    • written

      boolean written

  • Constructor Details

    • EventMonitor

      public EventMonitor(Receiver next)

  • Method Details

    • startElement

      public void startElement(NodeName elemName, SchemaType typeCode, 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 - integer code identifying the name of the element within the name pool.
      typeCode - the element's type annotation.
      location - a location associated with the event (typically either a location in the source document or the stylesheet)
      properties - properties of the element node
      Throws:
      XPathException - if an error occurs

    • namespace

      public void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.
      Specified by:
      namespace in interface Receiver
      Overrides:
      namespace in class ProxyReceiver
      Parameters:
      namespaceBindings - the prefix/uri pair representing the namespace binding
      properties - any special properties to be passed on this call
      Throws:
      XPathException - if an error occurs

    • attribute

      public void attribute(NodeName attName, SimpleType typeCode, CharSequence value, Location location, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
      Specified by:
      attribute in interface Receiver
      Overrides:
      attribute in class ProxyReceiver
      Parameters:
      attName - The name of the attribute
      typeCode - The type of the attribute
      value - the string value of the attribute
      location - The location of the node
      properties - Bit significant value. The following bits are defined:
      DISABLE_ESCAPING
      Disable escaping for this attribute
      NO_SPECIAL_CHARACTERS
      Attribute value contains no special characters
      Throws:
      XPathException - if an error occurs

    • characters

      public void characters(CharSequence chars, Location location, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      Parameters:
      chars - The characters
      location - 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

    • processingInstruction

      public void processingInstruction(String name, CharSequence data, Location location, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Processing Instruction
      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
      location - provides information such as line number and system ID.
      properties - Additional information about the PI.
      Throws:
      XPathException - if an error occurs

    • comment

      public void comment(CharSequence content, Location location, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      Parameters:
      content - The content of the comment
      location - provides information such as line number and system ID.
      properties - Additional information about the comment.
      Throws:
      XPathException - if an error occurs

    • append

      public void append(Item item, Location location, int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Append an arbitrary item (node or atomic value) to the output
      Specified by:
      append in interface Receiver
      Overrides:
      append in class ProxyReceiver
      Parameters:
      item - the item to be appended
      location - the location of the calling instruction, for diagnostics
      properties - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces
      Throws:
      XPathException

    • hasBeenWrittenTo

      public boolean hasBeenWrittenTo()