echoxul.util.sax
Class DebugSAXFilterDefaultHandler

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      echoxul.util.sax.SAXFilterDefaultHandler
          echoxul.util.sax.DebugSAXFilterDefaultHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

public class DebugSAXFilterDefaultHandler

extends SAXFilterDefaultHandler

Debug SAXFilterDefaultHandler. Using this class will log all method calls invoked on the DefaultHandler. By default, log output is written to a System.err, but this can be changed by overriding the log() method.

Author:

Terry Laurenzo

Constructor Summary

DebugSAXFilterDefaultHandler()
If using this ctor, you must call setParent

DebugSAXFilterDefaultHandler(java.lang.Object parent)
Construct and setParent in one step

Method Summary

void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
void	error(org.xml.sax.SAXParseException e)
void	fatalError(org.xml.sax.SAXParseException e)
protected java.lang.String	fmtObject(java.lang.Object obj)
protected java.lang.String	fmtString(java.lang.String s)
protected java.lang.String	formatAttributes(org.xml.sax.Attributes attrs)
void	ignorableWhitespace(char[] ch, int start, int length)
protected void	log(java.lang.String methodName, java.lang.String arguments, java.lang.String returnValue) Override to change log output
static void	main(java.lang.String[] args) main method for quick debugging of a SAX event stream for an XML input file.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
void	processingInstruction(java.lang.String target, java.lang.String data)
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId)
void	setDocumentLocator(org.xml.sax.Locator locator)
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
void	warning(org.xml.sax.SAXParseException e)

Methods inherited from class echoxul.util.sax.SAXFilterDefaultHandler

clearParent, comment, endCDATA, endDTD, endEntity, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setLexicalHandler, setParent, startCDATA, startDTD, startEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugSAXFilterDefaultHandler

public DebugSAXFilterDefaultHandler(java.lang.Object parent)

Construct and setParent in one step

Parameters:

parent - Delegation parent

DebugSAXFilterDefaultHandler

public DebugSAXFilterDefaultHandler()

If using this ctor, you must call setParent

Method Detail

log

protected void log(java.lang.String methodName,
                   java.lang.String arguments,
                   java.lang.String returnValue)

Override to change log output

Parameters:

methodName - Description of the Parameter

arguments - Description of the Parameter

returnValue - Description of the Parameter

fmtString

protected java.lang.String fmtString(java.lang.String s)

fmtObject

protected java.lang.String fmtObject(java.lang.Object obj)

formatAttributes

protected java.lang.String formatAttributes(org.xml.sax.Attributes attrs)

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws org.xml.sax.SAXException

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Overrides:

resolveEntity in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

notationDecl

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

Specified by:

notationDecl in interface org.xml.sax.DTDHandler

Overrides:

notationDecl in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

unparsedEntityDecl

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

Specified by:

unparsedEntityDecl in interface org.xml.sax.DTDHandler

Overrides:

unparsedEntityDecl in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

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

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class SAXFilterDefaultHandler

startDocument

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

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

endDocument

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

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

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

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

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

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

endElement

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

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

characters

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

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

processingInstruction

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

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

skippedEntity

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

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

warning in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

error in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

fatalError in class SAXFilterDefaultHandler

Throws:

org.xml.sax.SAXException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

main method for quick debugging of a SAX event stream for an XML input file. The first argument is the file name.

Throws:

java.lang.Exception