OpenJDK 27 · java.awt.event.InvocationEvent · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected boolean	catchExceptions Set to true if dispatch() catches Throwable and stores it in the exception instance variable.
private volatile boolean	dispatched
private Exception	exception
public static final int	INVOCATION_DEFAULT The default id for all InvocationEvents.
public static final int	INVOCATION_FIRST Marks the first integer id for the range of invocation event ids.
public static final int	INVOCATION_LAST Marks the last integer id for the range of invocation event ids.
private final Runnable	listener
protected volatile Object	notifier The (potentially null) Object whose notifyAll() method will be called immediately after the Runnable.run() method has returned or thrown an exception or after the event was disposed.
protected Runnable	runnable The Runnable whose run() method will be called.
private static final long	serialVersionUID Hides java.awt.AWTEvent.serialVersionUID. Use serialVersionUID from JDK 1.1 for interoperability.
private Throwable	throwable
private long	when The timestamp of when this event occurred.

Constructor Summary

Access	Constructor and Description
public	InvocationEvent(Object The `Object` that originated the event source, Runnable The `Runnable` whose `run()` method will be executed runnable) Constructs an `InvocationEvent` with the specified source which will execute the runnable's `run()` method when dispatched.
public	InvocationEvent(Object The `Object` that originated the event source, Runnable The `Runnable` whose `run()` method will be executed runnable, Object The `Object` whose `notifyAll` method will be called after `Runnable.run` has returned or thrown an exception or after the event was disposed notifier, boolean 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 catchThrowables) Constructs an `InvocationEvent` with the specified source which will execute the runnable's `run()` method when dispatched.
public	InvocationEvent(Object The `Object` that originated the event source, Runnable The `Runnable` whose `run()` method will be executed runnable, Runnable The `Runnable` whose `run()` method will be called after the `InvocationEvent` was dispatched or disposed listener, boolean 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 catchThrowables) Constructs an `InvocationEvent` with the specified source which will execute the runnable's `run()` method when dispatched.
protected	InvocationEvent(Object The `Object` that originated the event source, int An integer indicating the type of event. For information on allowable values, see the class description for `InvocationEvent` id, Runnable The `Runnable` whose `run()` method will be executed runnable, Object The `Object` whose `notifyAll` method will be called after `Runnable.run` has returned or thrown an exception or after the event was disposed notifier, boolean 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 catchThrowables) Constructs an `InvocationEvent` with the specified source and ID which will execute the runnable's `run()` method when dispatched.
private	InvocationEvent(Object source, int id, Runnable runnable, Object notifier, Runnable listener, boolean catchThrowables)

Method Summary

Modifier and Type	Method and Description
public void	dispatch() Implements java.awt.ActiveEvent.dispatch. Executes the Runnable's `run()` method and notifies the notifier (if any) when `run()` has returned or thrown an exception.
private void	finishedDispatching(boolean true if the event was dispatched false if the event was disposed dispatched) Called when the event was dispatched or disposed
public Exception	Returns: A reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions getException() Returns any Exception caught while executing the Runnable's `run()` method.
public Throwable	Returns: A reference to the Throwable if one was thrown; null if no Throwable was thrown or if this InvocationEvent does not catch Throwables getThrowable() Returns any Throwable caught while executing the Runnable's `run()` method.
public long	Returns: this event's timestamp getWhen() Returns the timestamp of when this event occurred.
public boolean	Returns: `true` if the event has been dispatched, or any exception has been thrown while dispatching, `false` otherwise isDispatched() Returns `true` if the event is dispatched or any exception is thrown while dispatching, `false` otherwise.
public String	Returns: A string identifying the event and its attributes paramString() Overrides java.awt.AWTEvent.paramString. Returns a parameter string identifying this event.

Inherited from java.awt.AWTEvent:: consume getID isConsumed setSource toString

Field Detail

catchExceptions	back to summary
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.

dispatched	back to summary
private volatile boolean dispatched Since 1.7 See Also `isDispatched`

exception	back to summary
private Exception exception

INVOCATION_DEFAULT	back to summary
public static final int INVOCATION_DEFAULT The default id for all InvocationEvents.

INVOCATION_FIRST	back to summary
public static final int INVOCATION_FIRST Marks the first integer id for the range of invocation event ids.

INVOCATION_LAST	back to summary
public static final int INVOCATION_LAST Marks the last integer id for the range of invocation event ids.

listener	back to summary
private final Runnable listener Annotations @SuppressWarnings:serial Since 1.8 See Also `isDispatched`

notifier	back to summary
protected volatile Object notifier The (potentially null) Object whose notifyAll() method will be called immediately after the Runnable.run() method has returned or thrown an exception or after the event was disposed. Annotations @SuppressWarnings:serial See Also `isDispatched`

runnable	back to summary
protected Runnable runnable The Runnable whose run() method will be called. Annotations @SuppressWarnings:serial

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.awt.AWTEvent.serialVersionUID. Use serialVersionUID from JDK 1.1 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.awt.AWTEvent.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.

Annotations

@Serial

throwable	back to summary
private Throwable throwable

when back to summary

when	back to summary
private long when The timestamp of when this event occurred. See Also `getWhen`

private long when

The timestamp of when this event occurred.

See Also: getWhen

Constructor Detail

InvocationEvent back to summary

InvocationEvent	back to summary
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 form `InvocationEvent(source, runnable)` behaves in exactly the same way as the invocation of `InvocationEvent(source, runnable, null, false)`. This method throws an `IllegalArgumentException` if `source` is `null`. Parameters source:Object The `Object` that originated the event runnable:Runnable The `Runnable` whose `run()` method will be executed Exceptions IllegalArgumentException: if `source` is null See Also `getSource()`, `InvocationEvent(Object, Runnable, Object, boolean)`

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 form InvocationEvent(source, runnable) behaves in exactly the same way as the invocation of InvocationEvent(source, runnable, null, false).

This method throws an IllegalArgumentException if source is null.

Parameters

source:Object: The Object that originated the event
runnable:Runnable: The Runnable whose run() method will be executed

Exceptions

IllegalArgumentException:: if source is null

InvocationEvent back to summary

InvocationEvent	back to summary
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()` 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`. Parameters source:Object The `Object` that originated the event runnable:Runnable The `Runnable` whose `run()` method will be executed notifier:Object The `Object` whose `notifyAll` method will be called after `Runnable.run` has returned or thrown an exception or after the event was disposed catchThrowables:boolean 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 Exceptions IllegalArgumentException: if `source` is null See Also `getSource()`, `InvocationEvent(Object, int, Runnable, Object, boolean)`

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

Parameters

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

Exceptions

IllegalArgumentException:: if source is null

InvocationEvent back to summary

InvocationEvent	back to summary
public InvocationEvent(Object source, Runnable runnable, Runnable listener, boolean catchThrowables) Constructs an `InvocationEvent` with the specified source which will execute the runnable's `run()` method when dispatched. If listener is non-`null`, `listener.run()` will be called immediately after `run` has returned, thrown an exception or the event was disposed. This method throws an `IllegalArgumentException` if `source` is `null`. Parameters source:Object The `Object` that originated the event runnable:Runnable The `Runnable` whose `run()` method will be executed listener:Runnable The `Runnable` whose `run()` method will be called after the `InvocationEvent` was dispatched or disposed catchThrowables:boolean 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 Exceptions IllegalArgumentException: if `source` is null

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

Constructs an InvocationEvent with the specified source which will execute the runnable's run() method when dispatched. If listener is non-null, listener.run() will be called immediately after run has returned, thrown an exception or the event was disposed.

This method throws an IllegalArgumentException if source is null.

Parameters

source:Object: The Object that originated the event
runnable:Runnable: The Runnable whose run() method will be executed
listener:Runnable: The Runnable whose run() method will be called after the InvocationEvent was dispatched or disposed
catchThrowables:boolean: 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

Exceptions

IllegalArgumentException:: if source is null

InvocationEvent back to summary

InvocationEvent	back to summary
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()` has returned or thrown an exception. This method throws an `IllegalArgumentException` if `source` is `null`. Parameters source:Object The `Object` that originated the event id:int An integer indicating the type of event. For information on allowable values, see the class description for `InvocationEvent` runnable:Runnable The `Runnable` whose `run()` method will be executed notifier:Object The `Object` whose `notifyAll` method will be called after `Runnable.run` has returned or thrown an exception or after the event was disposed catchThrowables:boolean 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 Exceptions IllegalArgumentException: if `source` is null See Also `getSource()`, `getID()`

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() has returned or thrown an exception.

This method throws an IllegalArgumentException if source is null.

Parameters

source:Object: The Object that originated the event
id:int: An integer indicating the type of event. For information on allowable values, see the class description for InvocationEvent
runnable:Runnable: The Runnable whose run() method will be executed
notifier:Object: The Object whose notifyAll method will be called after Runnable.run has returned or thrown an exception or after the event was disposed
catchThrowables:boolean: 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

Exceptions

IllegalArgumentException:: if source is null

See Also

getSource(), getID()

InvocationEvent	back to summary
private InvocationEvent(Object source, int id, Runnable runnable, Object notifier, Runnable listener, boolean catchThrowables)

Method Detail

dispatch back to summary

dispatch	back to summary
public void dispatch() Implements java.awt.ActiveEvent.dispatch. Executes the Runnable's `run()` method and notifies the notifier (if any) when `run()` has returned or thrown an exception. See Also `isDispatched`

public void dispatch()

Implements java.awt.ActiveEvent.dispatch.

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

See Also: isDispatched

finishedDispatching	back to summary
private void finishedDispatching(boolean dispatched) Called when the event was dispatched or disposed Parameters dispatched:boolean true if the event was dispatched false if the event was disposed

finishedDispatching

back to summary

private void finishedDispatching(boolean dispatched)

Called when the event was dispatched or disposed

Parameters

dispatched:boolean: true if the event was dispatched false if the event was disposed

getException back to summary

getException	back to summary
public Exception getException() Returns any Exception caught while executing the Runnable's `run()` method. Returns:Exception A reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions

public Exception getException()

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

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

getThrowable back to summary

getThrowable	back to summary
public Throwable getThrowable() Returns any Throwable caught while executing the Runnable's `run()` method. Returns:Throwable A reference to the Throwable if one was thrown; null if no Throwable was thrown or if this InvocationEvent does not catch Throwables Since 1.5

public Throwable getThrowable()

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

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

getWhen	back to summary
public long getWhen() Returns the timestamp of when this event occurred. Returns:long this event's timestamp Since 1.4

getWhen

back to summary

public long getWhen()

Returns the timestamp of when this event occurred.

Returns:long: this event's timestamp
Since: 1.4

isDispatched back to summary

isDispatched	back to summary
public boolean isDispatched() 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:boolean `true` if the event has been dispatched, or any exception has been thrown while dispatching, `false` otherwise Since 1.7 See Also `dispatch`, `notifier`, `catchExceptions`

public boolean isDispatched()

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:boolean: true if the event has been dispatched, or any exception has been thrown while dispatching, false otherwise
Since: 1.7
See Also: dispatch, notifier, catchExceptions

paramString	back to summary
public String paramString() Overrides java.awt.AWTEvent.paramString. Returns a parameter string identifying this event. This method is useful for event-logging and for debugging. Returns:String A string identifying the event and its attributes

paramString

back to summary

public String paramString()

Overrides java.awt.AWTEvent.paramString.

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

Returns:String: A string identifying the event and its attributes

public Class InvocationEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail