Class OutputterEventBuffer

java.lang.Object
net.sf.saxon.event.Outputter
net.sf.saxon.event.OutputterEventBuffer
All Implemented Interfaces:
Result, Receiver

public class OutputterEventBuffer extends Outputter
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
  • Constructor Details

    • OutputterEventBuffer

      public OutputterEventBuffer()
  • Method Details

    • setBuffer

      public void setBuffer(List<OutputterEvent> buffer)
    • startDocument

      public void startDocument(int properties) throws XPathException
      Description copied from class: Outputter
      Notify the start of a document node
      Specified by:
      startDocument in interface Receiver
      Specified by:
      startDocument in class Outputter
      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 class: Outputter
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Specified by:
      endDocument in class Outputter
      Throws:
      XPathException - if an error occurs
    • startElement

      public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties)
      Description copied from class: Outputter
      Notify the start of an element. This version of startElement() must be followed by calls on Outputter.attribute(NodeName, SimpleType, String, Location, int) and Outputter.namespace(String, NamespaceUri, int) to supply the attributes and namespaces; these calls may be terminated by a call on Outputter.startContent() but this is not mandatory.
      Specified by:
      startElement in class Outputter
      Parameters:
      elemName - the name of the element.
      typeCode - the type annotation of the element.
      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
    • startElement

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Description copied from class: Outputter
      Notify the start of an element, supplying all attributes and namespaces
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class Outputter
      Parameters:
      elemName - the name of the element.
      type - 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
    • attribute

      public void attribute(NodeName name, SimpleType type, String value, Location location, int properties)
      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
    • namespace

      public void namespace(String prefix, NamespaceUri uri, int properties)
      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:
    • startContent

      public void startContent()
      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
    • endElement

      public void endElement() throws XPathException
      Description copied from class: Outputter
      Notify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.
      Specified by:
      endElement in interface Receiver
      Specified by:
      endElement in class Outputter
      Throws:
      XPathException - if an error occurs
    • characters

      public void characters(UnicodeString chars, Location location, int properties)
      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
    • processingInstruction

      public void processingInstruction(String name, UnicodeString data, Location location, int properties)
      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.
    • comment

      public void comment(UnicodeString content, Location location, int properties)
      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.
    • append

      public void append(Item item, Location location, int properties)
      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
    • close

      public void close()
      Description copied from class: Outputter
      Notify the end of the event stream
      Specified by:
      close in interface Receiver
      Overrides:
      close in class Outputter
    • replay

      public void replay(Outputter 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
    • isEmpty

      public boolean isEmpty()
    • reset

      public void reset()