org.jwalk
Class ReportEvent

java.lang.Object
  java.util.EventObject
      org.jwalk.ReportEvent

All Implemented Interfaces:

java.io.Serializable

public class ReportEvent
extends java.util.EventObject

ReportEvent is a kind of event that notifies about a Report. A ReportEvent is generated every time a JWalker wishes to send a Report. This event wraps up a Report and the JWalker source which sent the Report. Client programs should register an object satisfying the ReportListener interface with JWalker's Channels API. The registered object will then accept ReportEvents raised by the JWalker.

Version:

1.0

Author:

Anthony Simons

See Also:

Serialized Form

Field Summary

protected Report

report The Report that is being sent in this ReportEvent.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ReportEvent(JWalker source, Report report)
Creates a ReportEvent with a dispatching source and a Report.

Method Summary

Report	getReport() Returns the Report being sent in this event.
JWalker	getSource() Returns the JWalker source which dispatched this event.
java.lang.String	toString() Returns a printable representation of this event.

Methods inherited from class java.lang.Object

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

Field Detail

report

protected Report report

The Report that is being sent in this ReportEvent.

Constructor Detail

ReportEvent

public ReportEvent(JWalker source,
                   Report report)

Creates a ReportEvent with a dispatching source and a Report.

Parameters:

source - the source object dispatching this ReportEvent.

report - the Report being sent in this ReportEvent.

Method Detail

getSource

public JWalker getSource()

Returns the JWalker source which dispatched this event.

Overrides:

getSource in class java.util.EventObject

Returns:

the JWalker which dispatched this event.

getReport

public Report getReport()

Returns the Report being sent in this event.

Returns:

the Report being sent in this event.

toString

public java.lang.String toString()

Returns a printable representation of this event. This is the same as the printable representation of the Report.

Overrides:

toString in class java.util.EventObject