Class UncommittedSerializer

  • All Implemented Interfaces:
    javax.xml.transform.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.
    Author:
    Michael H. Kay
    • Field Detail

      • committed

        boolean committed
      • pending

        java.util.List<net.sf.saxon.serialize.UncommittedSerializer.PendingNode> pending
      • finalResult

        javax.xml.transform.Result finalResult
      • outputProperties

        java.util.Properties outputProperties
    • Constructor Detail

      • UncommittedSerializer

        public UncommittedSerializer​(javax.xml.transform.Result finalResult,
                                     Receiver next,
                                     java.util.Properties outputProperties)
        Create an uncommitted Serializer
        Parameters:
        finalResult - the output destination
        next - the next receiver in the pipeline
        outputProperties - the serialization properties
    • Method Detail

      • characters

        public void characters​(java.lang.CharSequence chars,
                               int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        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 target,
                                          java.lang.CharSequence data,
                                          int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        properties - Additional information about the PI.
        Throws:
        XPathException - if an error occurs
      • comment

        public void comment​(java.lang.CharSequence chars,
                            int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        properties - Additional information about the comment.
        Throws:
        XPathException - if an error occurs
      • startElement

        public void startElement​(NodeName elemName,
                                 SchemaType typeCode,
                                 int locationId,
                                 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 element name (tag)
        typeCode - The type annotation
        properties - Bit field holding special properties of the element
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        Throws:
        XPathException - if an error occurs