net.sf.saxon.s9api.SAXDestination Maven / Gradle / Ivy
Show all versions of Saxon-HE Show documentation
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.s9api;
import net.sf.saxon.event.ContentHandlerProxy;
import net.sf.saxon.event.PipelineConfiguration;
import net.sf.saxon.event.Receiver;
import net.sf.saxon.serialize.SerializationProperties;
import org.xml.sax.ContentHandler;
/**
* This class represents a {@link Destination} (for example, the destination of the output of a transformation)
* in which events representing the XML document are sent to a user-supplied SAX2 {@link ContentHandler}, as
* if the {@code ContentHandler} were receiving the document directly from an XML parser.
* If the supplied {@code ContentHandler} implements the {@link org.xml.sax.ext.LexicalHandler} interface,
* then comment nodes will be notified to the handler; if not, comments will be silently ignored.
* Namespace-related information is reported to the {@code ContentHandler} following the conventions of
* an {@link org.xml.sax.XMLReader} configured with default values for the features
* {@code http://xml.org/sax/features/namespaces} and {@code http://xml.org/sax/features/namespace-prefixes}.
* If and only if the supplied {@code ContentHandler} implements the {@link javax.xml.transform.sax.TransformerHandler}
* interface, then unparsed entities may be notified to the {@link org.xml.sax.DTDHandler#unparsedEntityDecl(String, String, String, String)}
* method.
*/
public class SAXDestination extends AbstractDestination {
private final ContentHandler contentHandler;
/**
* Create a SAXDestination, supplying a SAX ContentHandler to which
* events will be routed
*
* @param handler the SAX ContentHandler that is to receive the output. If the
* ContentHandler is also a {@link org.xml.sax.ext.LexicalHandler} then it will also receive
* notification of events such as comments.
*/
public SAXDestination(ContentHandler handler) {
contentHandler = handler;
}
/**
* Return a Receiver. Saxon calls this method to obtain a Receiver, to which it then sends
* a sequence of events representing the content of an XML document.
*
* @param pipe The Saxon configuration. This is supplied so that the destination can
* use information from the configuration (for example, a reference to the name pool)
* to construct or configure the returned Receiver.
* @param params Serialization properties. Since this destination is not a serializing destination.
* the main property of interest is {@code item-separator}.
* @return the Receiver to which events are to be sent.
*/
/*@NotNull*/
@Override
public Receiver getReceiver(PipelineConfiguration pipe, SerializationProperties params) {
ContentHandlerProxy chp = new ContentHandlerProxy();
chp.setUnderlyingContentHandler(contentHandler);
chp.setPipelineConfiguration(pipe);
return params.makeSequenceNormalizer(chp);
}
/**
* Close the destination, allowing resources to be released. Saxon calls this method when
* it has finished writing to the destination.
*/
@Override
public void close() {
// no action
}
}