Class UncommittedSerializer

All Implemented Interfaces:
Result, Receiver

public class UncommittedSerializer extends ProxyReceiver
This class is used when the decision on which serialization method to use has to be delayed until the first element is read. It buffers comments and processing instructions until that happens; then when the first element arrives it creates a real serialization pipeline and uses that for future output.
  • Constructor Details Link icon

    • UncommittedSerializer Link icon

      public UncommittedSerializer(Result finalResult, Receiver next, SerializationProperties params)
      Create an uncommitted Serializer
      Parameters:
      finalResult - the output destination
      next - the next receiver in the pipeline
      params - the serialization properties including character maps
  • Method Details Link icon

    • open Link icon

      public void open() throws XPathException
      Description copied from class: ProxyReceiver
      Start of event stream
      Specified by:
      open in interface Receiver
      Overrides:
      open in class ProxyReceiver
      Throws:
      XPathException - if an error occurs
    • close Link icon

      public void close() throws XPathException
      End of document
      Specified by:
      close in interface Receiver
      Overrides:
      close in class ProxyReceiver
      Throws:
      XPathException - if an error occurs
    • characters Link icon

      public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
      Produce character output using the current Writer.
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      Parameters:
      chars - The characters
      locationId - 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 Link icon

      public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException
      Processing Instruction
      Specified by:
      processingInstruction in interface Receiver
      Overrides:
      processingInstruction in class ProxyReceiver
      Parameters:
      target - The PI name. This must be a legal name (it will not be checked).
      data - The data portion of the processing instruction
      locationId - provides information such as line number and system ID.
      properties - Additional information about the PI.
      Throws:
      XPathException - if an error occurs
    • comment Link icon

      public void comment(UnicodeString chars, Location locationId, int properties) throws XPathException
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      Parameters:
      chars - The content of the comment
      locationId - provides information such as line number and system ID.
      properties - Additional information about the comment.
      Throws:
      XPathException - if an error occurs
    • startElement Link icon

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Output an element start tag.
      This can only be called once: it switches to a substitute output generator for XML, XHTML, or HTML, depending on the element name.
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      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
    • startDocument Link icon

      public void startDocument(int properties) throws XPathException
      Description copied from class: ProxyReceiver
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyReceiver
      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 Link icon

      public void endDocument() throws XPathException
      Description copied from class: ProxyReceiver
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Overrides:
      endDocument in class ProxyReceiver
      Throws:
      XPathException - if an error occurs
    • append Link icon

      public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
      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
      locationId - the location of the calling instruction, for diagnostics
      copyNamespaces - 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