jdk.awt.event.InvocationEvent — clojure-interop/java.awt 1.0.5

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.

An unspecified behavior will be caused if the id parameter of any particular InvocationEvent instance is not in the range from INVOCATION_FIRST to INVOCATION_LAST.

*-invocation-default clj

Static Constant.

The default id for all InvocationEvents.

type: int

*-invocation-first clj

Static Constant.

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

type: int

*-invocation-last clj

Static Constant.

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

type: int

->invocation-event clj

(->invocation-event source runnable)

(->invocation-event source runnable notifier catch-throwables)

Constructor.

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 has returned or thrown an exception. An invocation of the form InvocationEvent(source, runnable, notifier, catchThrowables) behaves in exactly the same way as the invocation of InvocationEvent(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables). This method throws an IllegalArgumentException if source is null.

source - The Object that originated the event - java.lang.Object runnable - The Runnable whose run method will be executed - java.lang.Runnable notifier - The Object whose notifyAll method will be called after Runnable.run has returned or thrown an exception or after the event was disposed - java.lang.Object catch-throwables - 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 - boolean

throws: java.lang.IllegalArgumentException - if source is null

dispatch clj

(dispatch this)

Executes the Runnable's run() method and notifies the notifier (if any) when run() has returned or thrown an exception.

dispatched? clj

(dispatched? this)

Returns true if the event is dispatched or any exception is thrown while dispatching, false otherwise. The method should be called by a waiting thread that calls the notifier.wait() method. Since spurious wakeups are possible (as explained in Object.wait()), this method should be used in a waiting loop to ensure that the event got dispatched:

 while (!event.isDispatched()) {
     notifier.wait();
 }

If the waiting thread wakes up without dispatching the event, the isDispatched() method returns false, and the while loop executes once more, thus, causing the awakened thread to revert to the waiting mode.

If the notifier.notifyAll() happens before the waiting thread enters the notifier.wait() method, the while loop ensures that the waiting thread will not enter the notifier.wait() method. Otherwise, there is no guarantee that the waiting thread will ever be woken from the wait.

returns: true if the event has been dispatched, or any exception has been thrown while dispatching, false otherwise - boolean

get-exception clj

(get-exception this)

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 - java.lang.Exception

get-throwable clj

(get-throwable this)

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 - java.lang.Throwable

get-when clj

(get-when this)

Returns the timestamp of when this event occurred.

returns: this event's timestamp - long

param-string clj

(param-string this)

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

returns: A string identifying the event and its attributes - java.lang.String