Package org.apache.cocoon.xml.sax

Class EmbeddedSAXPipe

java.lang.Object

org.apache.cocoon.xml.sax.AbstractSAXProducer

org.apache.cocoon.xml.sax.AbstractSAXPipe

org.apache.cocoon.xml.sax.EmbeddedSAXPipe

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

@Deprecated(since="2022-01-27")
public class EmbeddedSAXPipe
extends AbstractSAXPipe

Deprecated.

This API is deprecated, migrate code to the XML APIs provided by the JDK.

This class implements a ContentHandler for embedding a full SAX event stream into an existing stream of SAX events. An instance of this class will pass unmodified all the SAX events to the linked ContentHandler, but it will ignore the startDocument/endDocument and startDTD/endDTD events, as well as all comment events within the DTD.

Constructor Summary

Constructors

Constructor	Description
EmbeddedSAXPipe(org.xml.sax.ContentHandler handler)	Deprecated. Creates an EmbeddedXMLPipe that writes into the given ContentHandler.

Method Summary

Modifier and Type	Method	Description
void	comment(char[] ch, int start, int len)	Deprecated. Ignore all comment events if between startDTD/endDTD events.
void	endDocument()	Deprecated. Ignore the endDocument event: this method does nothing.
void	endDTD()	Deprecated. Ignore the endDTD event: this method does nothing.
void	startDocument()	Deprecated. Ignore the startDocument event: this method does nothing.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)	Deprecated. Ignore the startDTD event: this method does nothing.

Methods inherited from class org.apache.cocoon.xml.sax.AbstractSAXPipe

characters, endCDATA, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startElement, startEntity, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.sax.AbstractSAXProducer

recycle, setContentHandler

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddedSAXPipe

public EmbeddedSAXPipe(org.xml.sax.ContentHandler handler)

Deprecated.

Creates an EmbeddedXMLPipe that writes into the given ContentHandler.

Method Detail

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Deprecated.

Ignore the startDocument event: this method does nothing.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class AbstractSAXPipe

Throws:

org.xml.sax.SAXException - if an error occurs

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Deprecated.

Ignore the endDocument event: this method does nothing.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class AbstractSAXPipe

Throws:

org.xml.sax.SAXException - if an error occurs

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
              throws org.xml.sax.SAXException

Deprecated.

Ignore the startDTD event: this method does nothing.

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

Overrides:

startDTD in class AbstractSAXPipe

Parameters:

name - The document type name.

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared.

Throws:

org.xml.sax.SAXException - if an error occurs

endDTD

public void endDTD()
            throws org.xml.sax.SAXException

Deprecated.

Ignore the endDTD event: this method does nothing.

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

Overrides:

endDTD in class AbstractSAXPipe

Throws:

org.xml.sax.SAXException - if an error occurs

comment

public void comment(char[] ch,
                    int start,
                    int len)
             throws org.xml.sax.SAXException

Deprecated.

Ignore all comment events if between startDTD/endDTD events.

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

Overrides:

comment in class AbstractSAXPipe

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

len - The number of characters to use from the array.

Throws:

org.xml.sax.SAXException - if an error occurs