class ErrorHandler

Basic interface for SAX error handlers

Inheritance:


Public

Constructors and Destructor
ErrorHandler ()
Default constructor
virtual ~ErrorHandler ()
Desctructor
The error handler interface
virtual void warning (const SAXParseException& exception)
Receive notification of a warning
virtual void error (const SAXParseException& exception)
Receive notification of a recoverable error
virtual void fatalError (const SAXParseException& exception)
Receive notification of a non-recoverable error
private Unimplemented constructors and operators
ErrorHandler (const ErrorHandler&)
Copy constructor
void operator= (const ErrorHandler&)
Assignment operator

Documentation

Basic interface for SAX error handlers.

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

The parser shall use this interface instead of throwing an exception: it is up to the application 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).

The HandlerBase class provides a default implementation of this interface, ignoring warnings and recoverable errors and throwing a SAXParseException for fatal errors. An application may extend that class rather than implementing the complete interface itself.

$Log: ErrorHandler.hpp,v $ Revision 1.1.1.1 1999/11/09 01:07:45 twl Initial checkin Revision 1.2 1999/11/08 20:45:00 rahul Swat for adding in Product name and CVS comment log variable.
Constructors and Destructor

ErrorHandler()
Default constructor

virtual ~ErrorHandler()
Desctructor

The error handler interface

virtual void warning(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
exception - The warning information encapsulated in a SAX parse exception.
See Also:
SAXParseException

virtual void error(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
exception - The error information encapsulated in a SAX parse exception.
See Also:
SAXParseException

virtual void fatalError(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
exception - The error information encapsulated in a SAX parse exception.
See Also:
SAXParseException

private Unimplemented constructors and operators

ErrorHandler(const ErrorHandler&)
Copy constructor

void operator=(const ErrorHandler&)
Assignment operator


Direct child classes:
HandlerBase
See Also:
setErrorHandler
SAXParseException
HandlerBase

alphabetic index hierarchy of classes


XML Parser for C++ 2.0
Copyright © IBM Corp, 1999
Center for Java Technology
10275 N. De Anza Blvd.
Cupertino CA 95014 USA
Email: xml4c@us.ibm.com

IBM Logo