class ErrorHandler

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

org::xml::sax::ErrorHandler Class Reference

#include <ErrorHandler.h>

Inheritance diagram for org::xml::sax::ErrorHandler:

List of all members.

Detailed Description

Basic interface for SAX error handlers.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

If a SAX application needs to implement customized error handling, it must implement this interface and then register an instance with the XML reader using the setErrorHandler method. The parser will then report all errors and warnings through this interface.

WARNING: If an application does not register an ErrorHandler, XML parsing errors will go unreported and bizarre behaviour may result.

For XML processing errors, a SAX driver must use this interface instead of throwing an exception: it is up to the application to decide whether to throw an exception for different types of errors and warnings. Note, however, that there is no requirement that the parser continue to provide useful information after a call to fatalError (in other words, a SAX driver class could catch an exception and report a fatalError).

Since:: SAX 1.0

Author:: Roger Rene Kommer (ACDK mapping)

See also:: org::xml::sax::XMLReader::setErrorHandler
org::xml::sax::SAXParseException

Public Member Functions

virtual void warning (IN(RSAXParseException) saxparseexception)=0 throw ( RSAXException )

Receive notification of a warning.

virtual void error (IN(RSAXParseException) saxparseexception)=0 throw ( RSAXException )

Receive notification of a recoverable error.

virtual void fatalError (IN(RSAXParseException) saxparseexception)=0 throw ( RSAXException )

Receive notification of a non-recoverable error.

Member Function Documentation

virtual void org::xml::sax::ErrorHandler::error ( IN(RSAXParseException) saxparseexception ) throw ( RSAXException ) [pure virtual]

Receive notification of a recoverable error.
This corresponds to the definition of error in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.
The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML 1.0 recommendation does not require it to do so.
Filters may use this method to report other, non-XML errors as well.

Parameters:

exception The error information encapsulated in a SAX parse exception.

Exceptions:

org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

See also:
org::xml::sax::SAXParseException

Implemented in org::xml::sax::HandlerBase, org::xml::sax::helpers::CollectiveErrorHandler, org::xml::sax::helpers::DefaultHandler, org::xml::sax::helpers::StdErrorHandler, and org::xml::sax::helpers::XMLFilterImpl.

virtual void org::xml::sax::ErrorHandler::fatalError ( IN(RSAXParseException) saxparseexception ) throw ( RSAXException ) [pure virtual]

Receive notification of a non-recoverable error.
This corresponds to the definition of fatal error in section 1.2 of the W3C XML 1.0 Recommendation. For example, a parser would use this callback to report the violation of a well-formedness constraint.
The application must assume that the document is unusable after the parser has invoked this method, and should continue (if at all) only for the sake of collecting addition error messages: in fact, SAX parsers are free to stop reporting any other events once this method has been invoked.

Parameters:

exception The error information encapsulated in a SAX parse exception.

Exceptions:

org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

See also:
org::xml::sax::SAXParseException

Implemented in org::xml::sax::HandlerBase, org::xml::sax::helpers::CollectiveErrorHandler, org::xml::sax::helpers::DefaultHandler, org::xml::sax::helpers::StdErrorHandler, and org::xml::sax::helpers::XMLFilterImpl.

virtual void org::xml::sax::ErrorHandler::warning ( IN(RSAXParseException) saxparseexception ) throw ( RSAXException ) [pure virtual]

Receive notification of a warning.
SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML 1.0 recommendation. The default behaviour is to take no action.
The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.
Filters may use this method to report other, non-XML warnings as well.

Parameters:

exception The warning information encapsulated in a SAX parse exception.

Exceptions:

org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

See also:
org::xml::sax::SAXParseException

Implemented in org::xml::sax::HandlerBase, org::xml::sax::helpers::CollectiveErrorHandler, org::xml::sax::helpers::DefaultHandler, org::xml::sax::helpers::StdErrorHandler, and org::xml::sax::helpers::XMLFilterImpl.