org.apache.excalibur.xml.sax

Class ContentHandlerWrapper

java.lang.Object

org.apache.excalibur.xml.sax.ContentHandlerWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultDOMHandler

Deprecated.

Use one of the replacement classes ContentHandlerProxy or XMLConsumerProxy

public class ContentHandlerWrapper
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

This class is an utility class "wrapping" around a SAX version 2.0 ContentHandler and forwarding it those events received throug its XMLConsumers interface.

Version:

CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:20 $

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
private org.xml.sax.ContentHandler	m_contentHandler Deprecated. The current ContentHandler.
private org.xml.sax.ext.LexicalHandler	m_lexicalHandler Deprecated. The optional LexicalHandler

Constructor Summary

Constructors

Constructor and Description
ContentHandlerWrapper() Deprecated. Create a new ContentHandlerWrapper instance.
ContentHandlerWrapper(org.xml.sax.ContentHandler contentHandler) Deprecated. Create a new ContentHandlerWrapper instance.
ContentHandlerWrapper(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler) Deprecated. Create a new ContentHandlerWrapper instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int len) Deprecated. Receive notification of character data.
void	comment(char[] ch, int start, int len) Deprecated. Report an XML comment anywhere in the document.
void	endCDATA() Deprecated. Report the end of a CDATA section.
void	endDocument() Deprecated. Receive notification of the end of a document.
void	endDTD() Deprecated. Report the end of DTD declarations.
void	endElement(java.lang.String uri, java.lang.String loc, java.lang.String raw) Deprecated. Receive notification of the end of an element.
void	endEntity(java.lang.String name) Deprecated. Report the end of an entity.
void	endPrefixMapping(java.lang.String prefix) Deprecated. End the scope of a prefix-URI mapping.
void	ignorableWhitespace(char[] ch, int start, int len) Deprecated. Receive notification of ignorable whitespace in element content.
void	processingInstruction(java.lang.String target, java.lang.String data) Deprecated. Receive notification of a processing instruction.
void	setContentHandler(org.xml.sax.ContentHandler contentHandler) Deprecated. Set the ContentHandler that will receive XML data.
void	setDocumentLocator(org.xml.sax.Locator locator) Deprecated. Receive an object for locating the origin of SAX document events.
void	setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) Deprecated. Set the LexicalHandler that will receive XML data.
void	skippedEntity(java.lang.String name) Deprecated. Receive notification of a skipped entity.
void	startCDATA() Deprecated. Report the start of a CDATA section.
void	startDocument() Deprecated. Receive notification of the beginning of a document.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Deprecated. Report the start of DTD declarations, if any.
void	startElement(java.lang.String uri, java.lang.String loc, java.lang.String raw, org.xml.sax.Attributes a) Deprecated. Receive notification of the beginning of an element.
void	startEntity(java.lang.String name) Deprecated. Report the beginning of an entity.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Deprecated. Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class java.lang.Object

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

Field Detail

m_contentHandler

private org.xml.sax.ContentHandler m_contentHandler

Deprecated.

The current ContentHandler.

m_lexicalHandler

private org.xml.sax.ext.LexicalHandler m_lexicalHandler

Deprecated.

The optional LexicalHandler

Constructor Detail

ContentHandlerWrapper

public ContentHandlerWrapper()

Deprecated.

Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper

public ContentHandlerWrapper(org.xml.sax.ContentHandler contentHandler)

Deprecated.

Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper

public ContentHandlerWrapper(org.xml.sax.ContentHandler contentHandler,
                     org.xml.sax.ext.LexicalHandler lexicalHandler)

Deprecated.

Create a new ContentHandlerWrapper instance.

Method Detail

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)
                       throws java.lang.IllegalStateException

Deprecated.

Set the ContentHandler that will receive XML data.

Throws:

java.lang.IllegalStateException - If the ContentHandler was already set.

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
                       throws java.lang.IllegalStateException

Deprecated.

Set the LexicalHandler that will receive XML data.

Throws:

java.lang.IllegalStateException - If the LexicalHandler was already set.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Deprecated.

Receive an object for locating the origin of SAX document events.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

startDocument

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

Deprecated.

Receive notification of the beginning of a document.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

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

Deprecated.

Receive notification of the end of a document.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)
                        throws org.xml.sax.SAXException

Deprecated.

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Deprecated.

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                java.lang.String loc,
                java.lang.String raw,
                org.xml.sax.Attributes a)
                  throws org.xml.sax.SAXException

Deprecated.

Receive notification of the beginning of an element.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
              java.lang.String loc,
              java.lang.String raw)
                throws org.xml.sax.SAXException

Deprecated.

Receive notification of the end of an element.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

characters

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

Deprecated.

Receive notification of character data.

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

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

Deprecated.

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)
                           throws org.xml.sax.SAXException

Deprecated.

Receive notification of a processing instruction.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

Deprecated.

Receive notification of a skipped entity.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Parameters:

name - The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.

Throws:

org.xml.sax.SAXException

startDTD

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

Deprecated.

Report the start of DTD declarations, if any.

Specified by:

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

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

endDTD

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

Deprecated.

Report the end of DTD declarations.

Specified by:

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

Throws:

org.xml.sax.SAXException

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

Deprecated.

Report the beginning of an entity.

Specified by:

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

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws:

org.xml.sax.SAXException

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

Deprecated.

Report the end of an entity.

Specified by:

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

Parameters:

name - The name of the entity that is ending.

Throws:

org.xml.sax.SAXException

startCDATA

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

Deprecated.

Report the start of a CDATA section.

Specified by:

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

Throws:

org.xml.sax.SAXException

endCDATA

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

Deprecated.

Report the end of a CDATA section.

Specified by:

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

Throws:

org.xml.sax.SAXException

comment

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

Deprecated.

Report an XML comment anywhere in the document.

Specified by:

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

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