Xerces-C++  3.1.3
List of all members
ErrorHandler Class Referenceabstract

Basic interface for SAX error handlers. More...

Inheritance diagram for ErrorHandler:
DefaultHandler HandlerBase

Public Member Functions

Constructors and Destructor
 ErrorHandler ()
 Default constructor. More...
 
virtual ~ErrorHandler ()
 Destructor. More...
 
The error handler interface
virtual void warning (const SAXParseException &exc)=0
 Receive notification of a warning. More...
 
virtual void error (const SAXParseException &exc)=0
 Receive notification of a recoverable error. More...
 
virtual void fatalError (const SAXParseException &exc)=0
 Receive notification of a non-recoverable error. More...
 
virtual void resetErrors ()=0
 Reset the Error handler object on its reuse. More...
 

Detailed Description

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.

See also
Parser::setErrorHandler
SAXParseException::SAXParseException
HandlerBase::HandlerBase

Constructor & Destructor Documentation

ErrorHandler::ErrorHandler ( )

Default constructor.

virtual ErrorHandler::~ErrorHandler ( )
virtual

Destructor.

Member Function Documentation

virtual void ErrorHandler::error ( const SAXParseException exc)
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.

Parameters
excThe error information encapsulated in a SAX parse exception.
Exceptions
SAXExceptionAny SAX exception, possibly wrapping another exception.
See also
SAXParseException::SAXParseException

Implemented in DefaultHandler, and HandlerBase.

virtual void ErrorHandler::fatalError ( const SAXParseException exc)
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
excThe error information encapsulated in a SAX parse exception.
Exceptions
SAXExceptionAny SAX exception, possibly wrapping another exception.
See also
SAXParseException::SAXParseException

Implemented in DefaultHandler, and HandlerBase.

virtual void ErrorHandler::resetErrors ( )
pure virtual

Reset the Error handler object on its reuse.

This method helps in reseting the Error handler object implementation defaults each time the Error handler is begun.

Implemented in DefaultHandler, and HandlerBase.

virtual void ErrorHandler::warning ( const SAXParseException exc)
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.

Parameters
excThe warning information encapsulated in a SAX parse exception.
Exceptions
SAXExceptionAny SAX exception, possibly wrapping another exception.
See also
SAXParseException::SAXParseException

Implemented in DefaultHandler, and HandlerBase.


The documentation for this class was generated from the following file: