Class Sender


  • public abstract class Sender
    extends java.lang.Object
    Sender is a helper class that sends events to a Receiver from any kind of Source object
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void configureParser​(org.xml.sax.XMLReader parser)
      Configure a SAX parser to ensure it has the correct namesapce properties set
      static void send​(javax.xml.transform.Source source, Receiver receiver, ParseOptions options)
      Send the contents of a Source to a Receiver.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • send

        public static void send​(javax.xml.transform.Source source,
                                Receiver receiver,
                                ParseOptions options)
                         throws XPathException
        Send the contents of a Source to a Receiver.
        Parameters:
        source - the source to be copied. Note that if the Source contains an InputStream or Reader then it will be left open, unless it is an AugmentedSource with the pleaseCloseAfterUse flag set. On the other hand, if it contains a URI that needs to be dereferenced to obtain an InputStream, then the InputStream will be closed after use.
        receiver - the destination to which it is to be copied. The pipelineConfiguration of this receiver must have been initialized. The implementation sends a sequence of events to the Receiver, starting with an Outputter.open() call and ending with Outputter.close(); this will be a regular event sequence as defined by RegularSequenceChecker.
        options - Parsing options. If source is an AugmentedSource, any options set in the AugmentedSource are used in preference to those set in options. If neither specifies a particular option, the defaults from the Configuration are used. If null is supplied, the parse options from the PipelineConfiguration of the receiver are used.
        Throws:
        XPathException - if any error occurs
      • configureParser

        public static void configureParser​(org.xml.sax.XMLReader parser)
                                    throws XPathException
        Configure a SAX parser to ensure it has the correct namesapce properties set
        Parameters:
        parser - the parser to be configured
        Throws:
        XPathException - if the parser cannot be configured to the required settings (namespaces=true, namespace-prefixes=false). Note that the SAX specification requires every XMLReader to support these settings, so this error implies that the XMLReader is non-conformant; this is not uncommon in cases where the XMLReader is user-written.