|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
java.awt.AWTEvent
java.awt.event.InvocationEvent
public class InvocationEvent
This event executes Runnable.run()
of a target object when it is
dispatched. This class is used by calls to invokeLater
and
invokeAndWait
, so client code can use this fact to avoid
writing special-casing AWTEventListener objects.
ActiveEvent
,
EventQueue.invokeLater(Runnable)
,
EventQueue.invokeAndWait(Runnable)
,
AWTEventListener
,
Serialized FormField Summary | |
---|---|
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. |
static int |
INVOCATION_DEFAULT
This is the default id for this event type. |
static int |
INVOCATION_FIRST
This is the first id in the range of event ids used by this class. |
static int |
INVOCATION_LAST
This is the last id in the range of event ids used by this class. |
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. |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
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. |
|
InvocationEvent(Object source,
Runnable runnable)
Initializes a new instance of InvocationEvent with the
specified source and runnable. |
|
InvocationEvent(Object source,
Runnable runnable,
Object notifier,
boolean catchExceptions)
Initializes a new instance of InvocationEvent with the
specified source, runnable, and notifier. |
Method Summary | |
---|---|
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. |
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. |
Throwable |
getThrowable()
Returns a throwable caught while executing the Runnable's run() method. |
long |
getWhen()
Gets the timestamp of when this event was created. |
String |
paramString()
This method returns a string identifying this event. |
Methods inherited from class java.awt.AWTEvent |
---|
consume, getID, isConsumed, setSource, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int INVOCATION_FIRST
public static final int INVOCATION_DEFAULT
public static final int INVOCATION_LAST
protected Runnable runnable
Runnable
object to call when dispatched.
protected Object notifier
notifyAll()
on when
the call to run()
returns, or null
if no
object is to be notified.
protected boolean catchExceptions
true
if exceptions are caught
and stored in a variable during the call to run()
, otherwise
exceptions are ignored and propagate up.
Constructor Detail |
---|
public InvocationEvent(Object source, Runnable runnable)
InvocationEvent
with the
specified source and runnable.
source
- the source of the eventrunnable
- the Runnable
object to invoke
IllegalArgumentException
- if source is nullpublic InvocationEvent(Object source, Runnable runnable, Object notifier, boolean catchExceptions)
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.
source
- the source of the eventrunnable
- the Runnable
object to invokenotifier
- the object to notify, or nullcatchExceptions
- true to catch exceptions from the runnableprotected InvocationEvent(Object source, int id, Runnable runnable, Object notifier, boolean catchExceptions)
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.
source
- the source of the eventid
- the event idrunnable
- the Runnable
object to invokenotifier
- the object to notify, or nullcatchExceptions
- true to catch exceptions from the runnableMethod Detail |
---|
public void dispatch()
run()
method of the runnable, traps
exceptions if instructed to do so, and calls notifyAll()
on any notifier if all worked successfully.
dispatch
in interface ActiveEvent
public Exception getException()
null
if not exception was thrown or
exceptions were not caught.
public Throwable getThrowable()
public long getWhen()
public String paramString()
"INVOCATION_DEFAULT,runnable=" + runnable + ",notifier=" + notifier
+ ",catchExceptions=" + catchExceptions + ",when=" + getWhen()
.
paramString
in class AWTEvent
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |