Class InvocationEvent

public static final int INVOCATION_DEFAULT

This is the default id for this event type.

Field Value:

1200

public static final int INVOCATION_FIRST

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

Field Value:

1200

public static final int INVOCATION_LAST

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

Field Value:

1200

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.

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.

protected Runnable runnable

This is the Runnable object to call when dispatched.

protected InvocationEvent(Object source,
                          int id,
                          Runnable runnable,
                          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:

source - the source of the event

id - the event id

runnable - the Runnable object to invoke

notifier - the object to notify, or null

catchExceptions - true to catch exceptions from the runnable

public InvocationEvent(Object source,
                       Runnable runnable)

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

Parameters:

source - the source of the event

runnable - the Runnable object to invoke

Throws:

IllegalArgumentException - if source is null

public InvocationEvent(Object source,
                       Runnable runnable,
                       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:

source - the source of the event

runnable - the Runnable object to invoke

notifier - the object to notify, or null

catchExceptions - true to catch exceptions from the runnable

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.

Specified by:

dispatch in interface ActiveEvent

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:

the exception thrown by the runnable

public Throwable getThrowable()

Returns a throwable caught while executing the Runnable's run() method. Null if none was thrown or if this InvocationEvent doesn't catch throwables.

Returns:

the caught Throwable

Since:

1.5

public long getWhen()

Gets the timestamp of when this event was created.

Returns:

the timestamp of this event

Since:

1.4

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().

Overrides:

paramString in interface AWTEvent

Returns:

a string identifying this event