org.crosswire.common.util
Class ReporterEvent

java.lang.Object
  java.util.EventObject
      org.crosswire.common.util.ReporterEvent

All Implemented Interfaces:

Serializable

public class ReporterEvent
extends EventObject

An event indicating that some bit of data needs capturing.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: ReporterEvent.java,v 1.3 2005/03/06 20:21:59 dmsmith Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence, Serialized Form

Field Summary

private Throwable	ex The thing that went wrong
private String	message The message that is being passed around
private static long	serialVersionUID Serialization ID

Fields inherited from class java.util.EventObject

source

Constructor Summary

ReporterEvent(Object source, String message)
Constructs an CaptureEvent object.

ReporterEvent(Object source, Throwable ex)
Constructs an CaptureEvent object.

Method Summary

Throwable	getException() Returns the exception.
String	getMessage() Returns the message.
String	getSourceName() Returns a string specifying the source of the message.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ex

private Throwable ex

The thing that went wrong

message

private String message

The message that is being passed around

serialVersionUID

private static final long serialVersionUID

Serialization ID

See Also:

Constant Field Values

Constructor Detail

ReporterEvent

public ReporterEvent(Object source,
                     Throwable ex)

Constructs an CaptureEvent object.

Parameters:

source - The event originator (typically this)

ex - An exception

ReporterEvent

public ReporterEvent(Object source,
                     String message)

Constructs an CaptureEvent object.

Parameters:

source - The event originator (typically this)

message - An message to log

Method Detail

getSourceName

public String getSourceName()

Returns a string specifying the source of the message.

Returns:

The Source as a String

getException

public Throwable getException()

Returns the exception.

Returns:

the Exception

getMessage

public String getMessage()

Returns the message.

Returns:

the message