All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface fr.inria.openmath.omapi.ParserErrorHandler

public interface ParserErrorHandler
Basic interface for OpenMath parse error handlers.

If an OpenMath application needs to implement customized error handling, it must implement this interface and then register an instance with the parser using the 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 driver class could catch an exception and report a fatalError).

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

See Also:
setParserErrorHandler, OMException, ParserErrorAdapter

Method Index

 o error(OMException)
Receives notification of a recoverable error.
 o fatalError(OMException)
Receives notification of a non-recoverable error.
 o warning(OMException)
Receives notification of a warning.

Methods

 o warning
 public abstract void warning(OMException exception) throws OMException
Receives notification of a warning.

OpenMath parsers will use this method to report conditions that are not errors or fatal errors. The default behaviour is to take no action.

The parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the OpenMath object stream through to the end.

Parameters:
exception - The trouble-shouting information encapsulated in a OpenMath exception.
Throws: OMException
Any OpenMath exception, possibly wrapping another exception.
See Also:
OMException
 o error
 public abstract void error(OMException exception) throws OMException
Receives notification of a recoverable error.

This corresponds to a more critical error. (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 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.

Parameters:
exception - The trouble-shouting information encapsulated in a OpenMath exception.
Throws: OMException
Any OpenMath exception, possibly wrapping another exception.
See Also:
OMException
 o fatalError
 public abstract void fatalError(OMException exception) throws OMException
Receives notification of a non-recoverable error.

This corresponds to a "fatal" error. 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, parsers are free to stop reporting any other events once this method has been invoked.

Parameters:
exception - The trouble-shouting information encapsulated in a OpenMath exception.
Throws: OMException
Any OpenMath exception, possibly wrapping another exception.
See Also:
OMException

All Packages  Class Hierarchy  This Package  Previous  Next  Index