org.youscope.common

Interface MessageListener

All Superinterfaces:

java.util.EventListener, java.rmi.Remote

public interface MessageListener
extends java.util.EventListener, java.rmi.Remote

Interface to allow an object to send messages, e.g. to the YouScope logging mechanism or to whomever is interested.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	sendErrorMessage(java.lang.String message, java.lang.Throwable error) Sends an error message to the listener.
void	sendMessage(java.lang.String message) Sends a message to the listener.

Method Detail

sendMessage

void sendMessage(java.lang.String message)
          throws java.rmi.RemoteException

Sends a message to the listener.

Parameters:

message - The message to send.

Throws:

java.rmi.RemoteException

sendErrorMessage

void sendErrorMessage(java.lang.String message,
                      java.lang.Throwable error)
               throws java.rmi.RemoteException

Sends an error message to the listener. Should only be called when the error is produced autonomously, i.e. not as a direct response to a function call. If a function is called and an error occurs in the function call, an error should be thrown instead of an error message be send. A typical example when an error message would be send is when a thread is started as a response to a function call, and an error occurs in the thread while the original function call already succeeded. Another example are errors occurring as response to the user interacting with UI components.

Parameters:

message - The message to send.

error - The error which occurred.

Throws:

java.rmi.RemoteException