echoxul.util.sax
Class BaseErrorContentHandler

java.lang.Object
  echoxul.util.sax.BaseErrorContentHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class BaseErrorContentHandler

extends java.lang.Object

implements org.xml.sax.ContentHandler

This class is designed to be a base class for implementing custom ContentHandlers. By default, the following methods will throw a SAXException:

• startElement
• endElement
• characters
• skippedEntity
• startDocument
• endDocument

The following methods do nothing:

• endPrefixMapping
• ignorableWhitespace
• processingInstruction
• startPrefixMapping

All errors are thrown by calling the raiseError method. By default, this method simply throws the exception. It can be overriden with custom behavior.

The setDocumentLocator method, if called will set the internal document locator used to build error messages. It can also be passed in in the constructor.

Author:

Terry Laurenzo

Constructor Summary

BaseErrorContentHandler()

BaseErrorContentHandler(org.xml.sax.Locator locator)

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)
protected java.lang.String	getLocationString() Returns a non-null location string.
void	ignorableWhitespace(char[] ch, int start, int length)
protected org.xml.sax.SAXException	newUnexpectedException(java.lang.String msg) Creates a new SAXException with the following text appended to msg: "at location " + getLocationString()
void	processingInstruction(java.lang.String target, java.lang.String data)
protected void	raiseError(org.xml.sax.SAXException e)
void	setDocumentLocator(org.xml.sax.Locator locator) Does nothing by default
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseErrorContentHandler

public BaseErrorContentHandler(org.xml.sax.Locator locator)

BaseErrorContentHandler

public BaseErrorContentHandler()

Method Detail

getLocationString

protected java.lang.String getLocationString()

Returns a non-null location string. Can only be called from within a ContentHandler method. The returned location is of the following form by default:
public/systemid(line, col)
If a public id is available, that is used, if a system id is available, then that is used.

newUnexpectedException

protected org.xml.sax.SAXException newUnexpectedException(java.lang.String msg)

Creates a new SAXException with the following text appended to msg: "at location " + getLocationString()

raiseError

protected void raiseError(org.xml.sax.SAXException e)
                   throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException - always unless overriden

setDocumentLocator

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

Does nothing by default

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

startDocument

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

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

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

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

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

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 localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

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 localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

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

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

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

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

Throws:

org.xml.sax.SAXException