Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.event

Class InvocationEvent

java.lang.Object
|
+--java.util.EventObject
   |
   +--java.awt.AWTEvent
      |
      +--java.awt.event.InvocationEvent

All Implemented Interfaces:

ActiveEvent, Serializable


public class InvocationEvent

extends AWTEvent

implements ActiveEvent

This event executes Runnable#run() of a target object when it is dispatched. This class is used by calls to invokeLater and invokeAndWait, so client code can use this fact to avoid writing special-casing AWTEventListener objects.

Since:Author:See Also:

Field Summary

static intINVOCATION_DEFAULT

This is the default id for this event type.
static intINVOCATION_FIRST

This is the first id in the range of event ids used by this class.
static intINVOCATION_LAST

This is the last id in the range of event ids used by this class.
booleancatchExceptions

This variable is set to true if exceptions are caught and stored in a variable during the call to run(), otherwise exceptions are ignored and propagate up.
java.lang.Objectnotifier

This is the object to call notifyAll() on when the call to run() returns, or null if no object is to be notified.
java.lang.Runnablerunnable

This is the Runnable object to call when dispatched.

Constructor Summary

InvocationEvent(java.lang.Object source, java.lang.Runnable runnable)

Initializes a new instance of InvocationEvent with the specified source and runnable.
InvocationEvent(java.lang.Object source, java.lang.Runnable runnable, java.lang.Object notifier, boolean catchExceptions)

Initializes a new instance of InvocationEvent with the specified source, runnable, and notifier.
InvocationEvent(java.lang.Object source, int id, java.lang.Runnable runnable, java.lang.Object notifier, boolean catchExceptions)

Initializes a new instance of InvocationEvent with the specified source, runnable, and notifier.

Method Summary

voiddispatch()

This method calls the run() method of the runnable, traps exceptions if instructed to do so, and calls notifyAll() on any notifier if all worked successfully.
java.lang.ExceptiongetException()

This method returns the exception that occurred during the execution of the runnable, or null if not exception was thrown or exceptions were not caught.
longgetWhen()

Gets the timestamp of when this event was created.
java.lang.StringparamString()

This method returns a string identifying this event.

Field Details

INVOCATION_DEFAULT

public static final int INVOCATION_DEFAULT

This is the default id for this event type.


INVOCATION_FIRST

public static final int INVOCATION_FIRST

This is the first id in the range of event ids used by this class.


INVOCATION_LAST

public static final int INVOCATION_LAST

This is the last id in the range of event ids used by this class.


catchExceptions

protected boolean catchExceptions

This variable is set to true if exceptions are caught and stored in a variable during the call to run(), otherwise exceptions are ignored and propagate up.


notifier

protected Object notifier

This is the object to call notifyAll() on when the call to run() returns, or null if no object is to be notified.


runnable

protected Runnable runnable

This is the Runnable object to call when dispatched.


Constructor Details

InvocationEvent

protected InvocationEvent(java.lang.Object source, int id, java.lang.Runnable runnable, java.lang.Object notifier, boolean catchExceptions)

Initializes a new instance of InvocationEvent with the specified source, runnable, and notifier. It will also catch exceptions if specified. If notifier is non-null, this will call notifyAll() on the object when the runnable is complete. If catchExceptions is true, this traps any exception in the runnable, otherwise it lets the exception propagate up the Event Dispatch thread. Note that an invalid id leads to unspecified results.

Parameters:


InvocationEvent

public InvocationEvent(java.lang.Object source, java.lang.Runnable runnable)

Initializes a new instance of InvocationEvent with the specified source and runnable.

Parameters:

Throws:


InvocationEvent

public InvocationEvent(java.lang.Object source, java.lang.Runnable runnable, java.lang.Object notifier, boolean catchExceptions)

Initializes a new instance of InvocationEvent with the specified source, runnable, and notifier. It will also catch exceptions if specified. If notifier is non-null, this will call notifyAll() on the object when the runnable is complete. If catchExceptions is true, this traps any exception in the runnable, otherwise it lets the exception propagate up the Event Dispatch thread.

Parameters:


Method Details

dispatch

public void dispatch()

This method calls the run() method of the runnable, traps exceptions if instructed to do so, and calls notifyAll() on any notifier if all worked successfully.


getException

public Exception getException()

This method returns the exception that occurred during the execution of the runnable, or null if not exception was thrown or exceptions were not caught.

Returns:


getWhen

public long getWhen()

Gets the timestamp of when this event was created.

Since:Returns:


paramString

public String paramString()

This method returns a string identifying this event. This is formatted as: "INVOCATION_DEFAULT,runnable=" + runnable + ",notifier=" + notifier + ",catchExceptions=" + catchExceptions + ",when=" + getWhen().

Returns: