Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsISAXErrorHandler Interface Reference

Basic interface for SAX error handlers. More...

import "nsISAXErrorHandler.idl";

Inheritance diagram for nsISAXErrorHandler:
Inheritance graph
[legend]
Collaboration diagram for nsISAXErrorHandler:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void error (in nsISAXLocator locator, in AString error)
 Receive notification of a recoverable error.
void fatalError (in nsISAXLocator locator, in AString error)
 Receive notification of a non-recoverable error.
void ignorableWarning (in nsISAXLocator locator, in AString error)
 Receive notification of a warning.

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 XML reader. 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. In order to detect validity errors, an ErrorHandler that does something with error() calls must be registered.

Definition at line 57 of file nsISAXErrorHandler.idl.


Member Function Documentation

void nsISAXErrorHandler::error ( in nsISAXLocator  locator,
in AString  error 
)

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 recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Parameters:
locatorThe locator object for the error (may be null).
errorThe error message.
void nsISAXErrorHandler::fatalError ( in nsISAXLocator  locator,
in AString  error 
)

Receive notification of a non-recoverable error.

There is an apparent contradiction between the documentation for this method and the documentation for ContentHandler.endDocument(). Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether endDocument() will or will not be invoked when the parser has reported a fatalError() or thrown an exception.

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 additional error messages: in fact, SAX parsers are free to stop reporting any other events once this method has been invoked.

Parameters:
locatorThe locator object for the error (may be null).
errorThe error message.
void nsISAXErrorHandler::ignorableWarning ( in nsISAXLocator  locator,
in AString  error 
)

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 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:
locatorThe locator object for the warning (may be null).
errorThe warning message.

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