File	Doc	Category	Size	Date	Package
InvocationEvent.java	API Doc	Java SE 6 API	9995	Tue Jun 10 00:25:24 BST 2008	java.awt.event

InvocationEvent

• java.lang.Object
  • java.util.EventObject
    • java.awt.AWTEvent

Fields Summary
public static final int	INVOCATION_FIRST Marks the first integer id for the range of invocation event ids.
public static final int	INVOCATION_DEFAULT The default id for all InvocationEvents.
public static final 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.
private Exception	exception The (potentially null) Exception thrown during execution of the Runnable.run() method. This variable will also be null if a particular instance does not catch exceptions.
private Throwable	throwable The (potentially null) Throwable thrown during execution of the Runnable.run() method. This variable will also be null if a particular instance does not catch exceptions.
private long	when The timestamp of when this event occurred.
private static final long	serialVersionUID

Constructors 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 {@link #InvocationEvent(Object, Runnable, Object, boolean) InvocationEvent}(source, runnable, null, false). This method throws an IllegalArgumentException if source is null. param source the Object that originated the event param runnable the Runnable whose run method will be executed throws IllegalArgumentException if source is null see #InvocationEvent(Object, Runnable, Object, boolean) this(source, runnable, null, false);
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 {@link #InvocationEvent(Object, int, Runnable, Object, boolean) InvocationEvent}(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables). This method throws an IllegalArgumentException if source is null. param source the Object that originated the event param runnable the Runnable whose run method will be executed param notifier the Object whose notifyAll method will be called after Runnable.run has returned param 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 if source is null see #InvocationEvent(Object, int, Runnable, Object, boolean) this(source, INVOCATION_DEFAULT, runnable, notifier, catchThrowables);
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 an IllegalArgumentException if source is null. param source the Object that originated the event param id the ID for the event param runnable the Runnable whose run method will be executed param notifier the Object whose notifyAll method will be called after Runnable.run has returned param 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 if source is null super(source, id); this.runnable = runnable; this.notifier = notifier; this.catchExceptions = catchThrowables; this.when = System.currentTimeMillis();

Methods Summary
public void	dispatch() Executes the Runnable's run() method and notifies the notifier (if any) when run() returns. if (catchExceptions) { try { runnable.run(); } catch (Throwable t) { if (t instanceof Exception) { exception = (Exception) t; } throwable = t; } } else { runnable.run(); } if (notifier != null) { synchronized (notifier) { notifier.notifyAll(); } }
public java.lang.Exception	getException() Returns any Exception caught while executing the Runnable's run() method. return A reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions return (catchExceptions) ? exception : null;
public java.lang.Throwable	getThrowable() Returns any Throwable caught while executing the Runnable's run() method. return 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 return (catchExceptions) ? throwable : null;
public long	getWhen() Returns the timestamp of when this event occurred. return this event's timestamp since 1.4 return when;
public java.lang.String	paramString() Returns a parameter string identifying this event. This method is useful for event-logging and for debugging. return A string identifying the event and its attributes String typeStr; switch(id) { case INVOCATION_DEFAULT: typeStr = "INVOCATION_DEFAULT"; break; default: typeStr = "unknown type"; } return typeStr + ",runnable=" + runnable + ",notifier=" + notifier + ",catchExceptions=" + catchExceptions + ",when=" + when;