Package ptolemy.moml

Interface ErrorHandler

All Known Implementing Classes:

ConfigurationApplication.IgnoreErrorHandler, RecorderErrorHandler, SimpleErrorHandler, StreamErrorHandler, VergilErrorHandler

public interface ErrorHandler

Interface for error handlers for the MoMLParser class.

Since:

Ptolemy II 1.0

Version:

$Id$

Author:

Edward A. Lee

See Also:

MoMLParser

Pt.AcceptedRating:

Red (reviewmoderator)

Pt.ProposedRating:

Red (eal)

Field Summary

Fields

Modifier and Type	Field	Description
static int	CANCEL	Indicator to cancel parsing XML.
static int	CONTINUE	Indicator to skip this element and continue parsing XML.
static int	RETHROW	Indicator to request that the exception be rethrown.

Method Summary

Modifier and Type	Method	Description
void	enableErrorSkipping(boolean enable)	Enable or disable skipping of errors.
int	handleError(java.lang.String element, NamedObj context, java.lang.Throwable exception)	Handle an error.

Field Detail

CONTINUE

static final int CONTINUE

Indicator to skip this element and continue parsing XML.

See Also:

Constant Field Values

CANCEL

static final int CANCEL

Indicator to cancel parsing XML.

See Also:

Constant Field Values

RETHROW

static final int RETHROW

Indicator to request that the exception be rethrown.

See Also:

Constant Field Values

Method Detail

enableErrorSkipping

void enableErrorSkipping(boolean enable)

Enable or disable skipping of errors. If this method is called with a true argument, then an implementation of this interface may ignore subsequent errors by returning CONTINUE in handleError() without reporting the error. If it is called with a false argument, then the implementation is expected to report all subsequent errors (but it is not required to do so).

This method is intended to be used when an operation may trigger a large number of errors, and the user interface wishes to offer the user the option of ignoring them. This method should be called with a true argument before the operation begins, and then called with a false argument after the operation ends.

Parameters:

enable - True to enable skipping, false to disable.

handleError

int handleError(java.lang.String element,
                NamedObj context,
                java.lang.Throwable exception)

Handle an error.

Parameters:

element - The XML element that triggered the error.

context - The container object for the element.

exception - The exception that was thrown.

Returns:

CONTINUE to skip this element, CANCEL to abort processing of the XML, or RETHROW to request that the exception be rethrown.