Package net.sf.saxon.event

Class EventBuffer

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    public class EventBuffer
extends SequenceReceiver
    An EventBuffer is a receiver of events that records the events in memory for subsequent replay. It is used, for example, in the implementation of try/catch, where events cannot be written directly to the final serializer in case an error occurs and is caught.

    Note that events are retained along with their properties, so the class implements "sticky disable-output-escaping" - text nodes can have selected characters marked with the disable-escaping property.

    Since:
    9.9

    • Method Detail

      • startDocument

        public void startDocument​(int properties)
                   throws XPathException
        Description copied from interface: Receiver
        Notify the start of a document node
        Parameters:
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs

      • endDocument

        public void endDocument()
                 throws XPathException
        Description copied from interface: Receiver
        Notify the end of a document node
        Throws:
        XPathException - if an error occurs

      • startElement

        public void startElement​(NodeName elemName,
                         SchemaType typeCode,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException
        Description copied from interface: Receiver
        Notify the start of an element
        Parameters:
        elemName - the name of the element.
        typeCode - 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
        Description copied from interface: Receiver
        Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
        Throws:
        XPathException - if an error occurs

      • characters

        public void characters​(UnicodeString chars,
                       Location location,
                       int properties)
                throws XPathException
        Description copied from interface: Receiver
        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.
        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,
                                  UnicodeString data,
                                  Location location,
                                  int properties)
                           throws XPathException
        Description copied from interface: Receiver
        Output a processing instruction
        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​(UnicodeString content,
                    Location location,
                    int properties)
             throws XPathException
        Description copied from interface: Receiver
        Notify a comment. Comments are only notified if they are outside the DTD.
        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: SequenceReceiver
        Append an arbitrary item (node, atomic value, or function) to the output
        Specified by:
        append in interface Receiver
        Specified by:
        append in class SequenceReceiver
        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

      • replay

        public void replay​(Receiver out)
            throws XPathException
        Replay the captured events to a supplied destination
        Parameters:
        out - the destination Receiver to receive the events
        Throws:
        XPathException - if any error occurs