org.apache.excalibur.xml.sax

Class XMLConsumerProxy

java.lang.Object

org.apache.excalibur.xml.sax.ContentHandlerProxy

org.apache.excalibur.xml.sax.XMLConsumerProxy

All Implemented Interfaces:

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

public class XMLConsumerProxy
extends ContentHandlerProxy
implements XMLConsumer

This class is an utility class proxying a SAX version 2.0 ContentHandler and LexicalHandler 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.ext.LexicalHandler	m_lexicalHandler The LexicalHandler

Constructor Summary

Constructors

Constructor and Description
XMLConsumerProxy() Create a new XMLConsumerProxy instance.
XMLConsumerProxy(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler) Create a new XMLConsumerProxy instance.
XMLConsumerProxy(XMLConsumer xmlConsumer) Create a new XMLConsumerProxy instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	comment(char[] ch, int start, int len) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endDTD() Report the end of DTD declarations.
void	endEntity(java.lang.String name) Report the end of an entity.
void	setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) Set the lexical handler
void	startCDATA() Report the start of a CDATA section.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Report the start of DTD declarations, if any.
void	startEntity(java.lang.String name) Report the beginning of an entity.

Methods inherited from class org.apache.excalibur.xml.sax.ContentHandlerProxy

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setContentHandler, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Field Detail

m_lexicalHandler

private org.xml.sax.ext.LexicalHandler m_lexicalHandler

The LexicalHandler

Constructor Detail

XMLConsumerProxy

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

Create a new XMLConsumerProxy instance.

XMLConsumerProxy

public XMLConsumerProxy()

Create a new XMLConsumerProxy instance. If you use this constructor, you have to set the content handler by calling ContentHandlerProxy.setContentHandler(ContentHandler) and the lexical handler by calling setLexicalHandler(LexicalHandler). Otherwise you get an NPE during streaming.

XMLConsumerProxy

public XMLConsumerProxy(XMLConsumer xmlConsumer)

Create a new XMLConsumerProxy instance.

Method Detail

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)

Set the lexical handler

startDTD

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

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

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

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

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

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

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

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