InvocationEvent (Java 2 Platform SE 5.0) (original) (raw)

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

An event which executes the run() method on a Runnable when dispatched by the AWT event dispatcher thread. This class can be used as a reference implementation of ActiveEvent rather than declaring a new class and defining dispatch().

Instances of this class are placed on the EventQueue by calls to invokeLater and invokeAndWait. Client code can use this fact to write replacement functions for invokeLater and invokeAndWait without writing special-case code in any AWTEventListener objects.

Since:

1.2

See Also:

ActiveEvent, EventQueue.invokeLater(java.lang.Runnable), EventQueue.invokeAndWait(java.lang.Runnable), AWTEventListener, Serialized Form

INVOCATION_FIRST

public static final int INVOCATION_FIRST

Marks the first integer id for the range of invocation event ids.

See Also:

Constant Field Values

INVOCATION_DEFAULT

public static final int INVOCATION_DEFAULT

The default id for all InvocationEvents.

See Also:

Constant Field Values

INVOCATION_LAST

public static final int INVOCATION_LAST

Marks the last integer id for the range of invocation event ids.

See Also:

Constant Field Values

runnable

protected Runnable runnable

The Runnable whose run() method will be called.

notifier

protected Object notifier

The (potentially null) Object whose notifyAll() method will be called immediately after the Runnable.run() method returns.

catchExceptions

protected boolean catchExceptions

Set to true if dispatch() catches Throwable and stores it in the exception instance variable. If false, Throwables are propagated up to the EventDispatchThread's dispatch loop.

InvocationEvent

public InvocationEvent(Object source, Runnable runnable)

Constructs an InvocationEvent with the specified source which will execute the runnable's run method when dispatched.

This is a convenience constructor. An invocation of the formInvocationEvent(source, runnable) behaves in exactly the same way as the invocation of[InvocationEvent](../../../java/awt/event/InvocationEvent.html#InvocationEvent%28java.lang.Object, java.lang.Runnable, java.lang.Object, boolean%29)(source, runnable, null, false).

This method throws an IllegalArgumentException if source is null.

Parameters:

source - the Object that originated the event

runnable - the Runnable whose run method will be executed

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if source is null

See Also:

[InvocationEvent(Object, Runnable, Object, boolean)](../../../java/awt/event/InvocationEvent.html#InvocationEvent%28java.lang.Object, java.lang.Runnable, java.lang.Object, boolean%29)

InvocationEvent

public InvocationEvent(Object source, Runnable runnable, Object notifier, boolean catchThrowables)

Constructs an InvocationEvent with the specified source which will execute the runnable's run method when dispatched. If notifier is non-null,notifyAll() will be called on it immediately after run returns.

An invocation of the form InvocationEvent(source, runnable, notifier, catchThrowables) behaves in exactly the same way as the invocation of[InvocationEvent](../../../java/awt/event/InvocationEvent.html#InvocationEvent%28java.lang.Object, int, java.lang.Runnable, java.lang.Object, boolean%29)(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables).

This method throws an IllegalArgumentException if source is null.

Parameters:

source - the Object that originated the event

runnable - the Runnable whoserun method will be executed

notifier - the Object whose notifyAll method will be called afterRunnable.run has returned

catchThrowables - specifies whether dispatch should catch Throwable when executing the Runnable's run method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if source is null

See Also:

[InvocationEvent(Object, int, Runnable, Object, boolean)](../../../java/awt/event/InvocationEvent.html#InvocationEvent%28java.lang.Object, int, java.lang.Runnable, java.lang.Object, boolean%29)

InvocationEvent

protected InvocationEvent(Object source, int id, Runnable runnable, Object notifier, boolean catchThrowables)

Constructs an InvocationEvent with the specified source and ID which will execute the runnable's run method when dispatched. If notifier is non-null,notifyAll will be called on it immediately after run returns.

Note that passing in an invalid id results in unspecified behavior. This method throws anIllegalArgumentException if source is null.

Parameters:

source - the Object that originated the event

id - the ID for the event

runnable - the Runnable whoserun method will be executed

notifier - the Object whose `notifyAll` method will be called after`Runnable.run` has returned

`catchThrowables` - specifies whether `dispatch` should catch Throwable when executing the`Runnable`'s `run` method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop

**Throws:**

`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` - if `source` is null

``

`` | Method Detail | | ----------------- |

dispatch

public void dispatch()

Executes the Runnable's run() method and notifies the notifier (if any) when run() returns.

Specified by:

[dispatch](../../../java/awt/ActiveEvent.html#dispatch%28%29) in interface [ActiveEvent](../../../java/awt/ActiveEvent.html "interface in java.awt")

getException

public Exception getException()

Returns any Exception caught while executing the Runnable's run() method.

Returns:

A reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions

getThrowable

public Throwable getThrowable()

Returns any Throwable caught while executing the Runnable's run() method.

Returns:

A reference to the Throwable if one was thrown; null if no Throwable was thrown or if this InvocationEvent does not catch Throwables

getWhen

public long getWhen()

Returns the timestamp of when this event occurred.

Returns:

this event's timestamp

Since:

1.4

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Overrides:

[paramString](../../../java/awt/AWTEvent.html#paramString%28%29) in class [AWTEvent](../../../java/awt/AWTEvent.html "class in java.awt")

Returns:

A string identifying the event and its attributes

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

``