Class EventMonitor

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver

    public class EventMonitor
    extends Outputter
    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
    • Constructor Detail

      • EventMonitor

        public EventMonitor​(Outputter next)
    • Method Detail

      • attribute

        public void attribute​(NodeName name,
                              SimpleType type,
                              java.lang.CharSequence value,
                              Location location,
                              int properties)
                       throws XPathException
        Description copied from class: Outputter
        Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
        Specified by:
        attribute in class Outputter
        Parameters:
        name - The name of the attribute
        type - The type annotation of the attribute
        value - the string value of the attribute
        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 attribute
        NO_SPECIAL_CHARACTERS
        Attribute value contains no special characters
        Throws:
        XPathException - if an error occurs
      • namespace

        public void namespace​(java.lang.String prefix,
                              java.lang.String uri,
                              int properties)
                       throws XPathException
        Description copied from class: Outputter
        Notify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.
        Specified by:
        namespace in class Outputter
        Parameters:
        prefix - The namespace prefix; zero-length string for the default namespace
        uri - The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.
        properties - The REJECT_DUPLICATES property: if set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
        Throws:
        XPathException - if an error occurs
      • startContent

        public void startContent()
                          throws XPathException
        Description copied from class: Outputter
        Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.
        Overrides:
        startContent in class Outputter
        Throws:
        XPathException - if an error occurs
      • characters

        public void characters​(java.lang.CharSequence chars,
                               Location location,
                               int properties)
                        throws XPathException
        Description copied from class: Outputter
        Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
        Specified by:
        characters in interface Receiver
        Specified by:
        characters in class Outputter
        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​(java.lang.String name,
                                          java.lang.CharSequence data,
                                          Location location,
                                          int properties)
                                   throws XPathException
        Description copied from class: Outputter
        Output a processing instruction
        Specified by:
        processingInstruction in interface Receiver
        Specified by:
        processingInstruction in class Outputter
        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​(java.lang.CharSequence content,
                            Location location,
                            int properties)
                     throws XPathException
        Description copied from class: Outputter
        Notify a comment. Comments are only notified if they are outside the DTD.
        Specified by:
        comment in interface Receiver
        Specified by:
        comment in class Outputter
        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: Outputter
        Append an arbitrary item (node, atomic value, or function) to the output. The default implementation throws UnsupportedOperationException.
        Specified by:
        append in interface Receiver
        Overrides:
        append in class Outputter
        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 ReceiverOption.ALL_NAMESPACES; the default (0) means
        Throws:
        XPathException - if an error occurs
      • hasBeenWrittenTo

        public boolean hasBeenWrittenTo()