org.j3d.util
Interface ErrorReporter

All Known Implementing Classes:

DefaultErrorReporter

public interface ErrorReporter

Generalised interface for reporting errors of any kind that happens in the Web3D codebase.

Where methods provide both a string and exception, either of the values may be null, but not both at the same time.

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	warningReport(java.lang.String msg, java.lang.Exception e) Notification of a warning in the way the system is currently operating.

Method Detail

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 locate a needed file or system property.

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.