public class java.awt.event
InvocationEvent


Show All Login
Java SE 6
  
Extends: EventObject > AWTEvent
Implements: ActiveEvent
Details
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.
version1.21, 04/07/06
since1.2
See also java.awt.ActiveEvent, invokeLater, invokeAndWait, java.awt.event.AWTEventListener


Fields
final public static int INVOCATION_FIRST
Marks the first integer id for the range of invocation event ids.
final public static int INVOCATION_DEFAULT
The default id for all InvocationEvents.
final public static int INVOCATION_LAST
Marks the last integer id for the range of invocation event ids.
protected Runnable runnable
The Runnable whose run() method will be called.
protected Object notifier
The (potentially null) Object whose notifyAll() method will be called immediately after the Runnable.run() method returns.
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.

Constructors
public InvocationEvent(Object source, Runnable runnable) Details
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.
sourcethe Object that originated the event
runnablethe Runnable whose run method will be executed
ThrowsIllegalArgumentException: if source is null
See also InvocationEvent(Object, Runnable, Object, boolean)

public InvocationEvent(Object source, Runnable runnable, Object notifier, boolean catchThrowables) Details
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(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables).

This method throws an IllegalArgumentException if source is null.
sourcethe Object that originated the event
runnablethe Runnable whose run method will be executed
notifierthe Object whose notifyAll method will be called after Runnable.run has returned
catchThrowablesspecifies whether dispatch should catch Throwable when executing the Runnable's run method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop
ThrowsIllegalArgumentException: if source is null
See also InvocationEvent(Object, int, Runnable, Object, boolean)

protected InvocationEvent(Object source, int id, Runnable runnable, Object notifier, boolean catchThrowables) Details
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 an IllegalArgumentException if source is null.
sourcethe Object that originated the event
idthe ID for the event
runnablethe Runnable whose run method will be executed
notifierthe Object whose notifyAll method will be called after Runnable.run has returned
catchThrowablesspecifies whether dispatch should catch Throwable when executing the Runnable's run method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop
ThrowsIllegalArgumentException: if source is null


Methods
public void dispatch()
Executes the Runnable's run() method and notifies the notifier (if any) when run() returns.
public String paramString() Details
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
returnA string identifying the event and its attributes

Properties
public Exception getException() Details
Returns any Exception caught while executing the Runnable's run() method.
returnA reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions
public Throwable getThrowable() Details
Returns any Throwable caught while executing the Runnable's run() method.
returnA reference to the Throwable if one was thrown; null if no Throwable was thrown or if this InvocationEvent does not catch Throwables
since1.5
public long getWhen() Details
Returns the timestamp of when this event occurred.
returnthis event's timestamp
since1.4
About DocWeb · Bundles · Export · Export AllTop 10 · Statistics · Login
About Sun · Contact · Privacy · Terms of Use · Trademarks
Java SE 6
· Copyright © 1994-2013 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms