org.xj3d.sai
Interface Xj3DErrorReporter

public interface Xj3DErrorReporter

Generalised interface for reporting errors and messages of any kind that happens in the browser.

The error reporter does not get given the same messages as those from the Xj3DStatusListener interface. That interface is for transient messages such as descriptions of objects as you mouse over them. This interface is used for longer-lasting messages, such as those that would be recorded in a logging interface. What is seen here is the same as the error console messages if you were running the full browser.

Where methods provide both a string and exception, either of the values may be null, but not both at the same time. Exceptions presented will be those available in the SAI and this package, not internal to the browser, unless there is something fatal that we miss. Any translation between exception types will be automatically handled by the implementation before being sent to this interface.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Method Summary

void	errorReport(java.lang.String msg, java.lang.Exception e) Notification of a recoverable error.
void	fatalErrorReport(java.lang.String msg, java.lang.Exception e) Notification of a non-recoverable error that halts the entire system.
void	messageReport(java.lang.String msg) Notification of an informational message from the system.
void	partialReport(java.lang.String msg) Notification of an partial message from the system.
void	warningReport(java.lang.String msg, java.lang.Exception e) Notification of a warning in the way the system is currently operating.

Method Detail

partialReport

void partialReport(java.lang.String msg)

Notification of an partial message from the system. When being written out to a display device, a partial message does not have a line termination character appended to it, allowing for further text to appended on that same line.

Parameters:

msg - The text of the message to be displayed

messageReport

void messageReport(java.lang.String msg)

Notification of an informational message from the system. For example, it may issue a message when a URL cannot be resolved.

Parameters:

msg - The text of the message to be displayed

warningReport

void warningReport(java.lang.String msg,
                   java.lang.Exception e)

Notification of a warning in the way the system is currently operating. This is a non-fatal, non-serious error. For example you will get an warning when a value has been set that is out of range.

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

Throws:

VRMLException - This is bad enough that the reporter should stop what they are currently doing.

errorReport

void errorReport(java.lang.String msg,
                 java.lang.Exception e)

Notification of a recoverable error. This is a serious, but non-fatal error, for example trying to add a route to a non-existent node or the use of a node that the system cannot find the definition of.

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

Throws:

VRMLException - This is bad enough that the reporter should stop what they are currently doing.

fatalErrorReport

void fatalErrorReport(java.lang.String msg,
                      java.lang.Exception e)

Notification of a non-recoverable error that halts the entire system. After you recieve this report the runtime system will no longer function - for example a non-recoverable parsing error. The best way out is to reload the file or restart the application internals.

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

Throws:

VRMLException - This is bad enough that the reporter should stop what they are currently doing.