org.web3d.util
Interface ErrorReporter

All Superinterfaces:

org.j3d.util.ErrorReporter

All Known Subinterfaces:

ErrorHandler

All Known Implementing Classes:

AWTConsoleWindow, DefaultErrorReporter, SwingConsoleWindow

public interface ErrorReporter

extends org.j3d.util.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.6 $

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

public 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

public 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.

Specified by:

messageReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

warningReport

public 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.

Specified by:

warningReport in interface org.j3d.util.ErrorReporter

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

public 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.

Specified by:

errorReport in interface org.j3d.util.ErrorReporter

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

public 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.

Specified by:

fatalErrorReport in interface org.j3d.util.ErrorReporter

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.