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().+ * An event which executes the {@code run()} method on a {@code Runnable + * } when dispatched by the AWT event dispatcher thread. This class can + * be used as a reference implementation of {@code ActiveEvent} rather + * than declaring a new class and defining {@code 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.
+ * Instances of this class are placed on the {@code EventQueue} by calls
+ * to {@code invokeLater} and {@code invokeAndWait}. Client code
+ * can use this fact to write replacement functions for {@code invokeLater
+ * } and {@code invokeAndWait} without writing special-case code
+ * in any {@code AWTEventListener} objects.
*
* An unspecified behavior will be caused if the {@code id} parameter
* of any particular {@code InvocationEvent} instance is not
@@ -106,7 +106,7 @@
private final Runnable listener;
/**
- * Indicates whether the run() method of the runnable
+ * Indicates whether the {@code run()} method of the {@code runnable}
* was executed or not.
*
* @see #isDispatched
@@ -149,20 +149,21 @@
private static final long serialVersionUID = 436056344909459450L;
/**
- * Constructs an InvocationEvent with the specified
- * source which will execute the runnable's run
+ * Constructs an {@code InvocationEvent} with the specified
+ * source which will execute the runnable's {@code run}
* method when dispatched.
*
This is a convenience constructor. An invocation of the form - * InvocationEvent(source, runnable) + * {@code 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.
+ * {@link #InvocationEvent(Object, Runnable, Object, boolean)
+ * InvocationEvent(source, runnable, null, false)}.
+ *
This method throws an {@code IllegalArgumentException}
+ * if {@code source} is {@code null}.
*
- * @param source The Object that originated the event
- * @param runnable The Runnable whose run
+ * @param source The {@code Object} that originated the event
+ * @param runnable The {@code Runnable} whose {@code run}
* method will be executed
- * @throws IllegalArgumentException if source is null
+ * @throws IllegalArgumentException if {@code source} is null
*
* @see #getSource()
* @see #InvocationEvent(Object, Runnable, Object, boolean)
@@ -172,35 +173,36 @@
}
/**
- * 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) + * Constructs an {@code InvocationEvent} with the specified + * source which will execute the runnable's {@code run} + * method when dispatched. If notifier is non-{@code null}, + * {@code notifyAll()} will be called on it + * immediately after {@code run} has returned or thrown an exception. + *
An invocation of the form + * {@code 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.
+ * {@link #InvocationEvent(Object, int, Runnable, Object, boolean)
+ * InvocationEvent(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables)}.
+ *
This method throws an {@code IllegalArgumentException}
+ * if {@code source} is {@code null}.
*
- * @param source The Object that originated
+ * @param source The {@code Object} that originated
* the event
- * @param runnable The Runnable whose
- * run method will be
+ * @param runnable The {@code Runnable} whose
+ * {@code run} method will be
* executed
- * @param notifier The {@code Object} whose notifyAll
+ * @param notifier The {@code Object} whose {@code notifyAll}
* method will be called after
- * Runnable.run has returned or
+ * {@code Runnable.run} has returned or
* thrown an exception or after the event was
* disposed
- * @param catchThrowables Specifies whether dispatch
+ * @param catchThrowables Specifies whether {@code dispatch}
* should catch Throwable when executing
- * the Runnable's run
+ * the {@code Runnable}'s {@code run}
* method, or should instead propagate those
* Throwables to the EventDispatchThread's
* dispatch loop
- * @throws IllegalArgumentException if source is null
+ * @throws IllegalArgumentException if {@code source} is null
*
* @see #getSource()
* @see #InvocationEvent(Object, int, Runnable, Object, boolean)
@@ -211,31 +213,31 @@
}
/**
- * 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
+ * Constructs an {@code InvocationEvent} with the specified
+ * source which will execute the runnable's {@code run}
+ * method when dispatched. If listener is non-{@code null},
+ * {@code listener.run()} will be called immediately after
+ * {@code run} has returned, thrown an exception or the event
* was disposed.
- *
This method throws an IllegalArgumentException
- * if source is null.
+ *
This method throws an {@code IllegalArgumentException}
+ * if {@code source} is {@code null}.
*
- * @param source The Object that originated
+ * @param source The {@code Object} that originated
* the event
- * @param runnable The Runnable whose
- * run method will be
+ * @param runnable The {@code Runnable} whose
+ * {@code run} method will be
* executed
- * @param listener The RunnableRunnable whose
- * run() method will be called
+ * @param listener The {@code Runnable}Runnable whose
+ * {@code run()} method will be called
* after the {@code InvocationEvent}
* was dispatched or disposed
- * @param catchThrowables Specifies whether dispatch
+ * @param catchThrowables Specifies whether {@code dispatch}
* should catch Throwable when executing
- * the Runnable's run
+ * the {@code Runnable}'s {@code run}
* method, or should instead propagate those
* Throwables to the EventDispatchThread's
* dispatch loop
- * @throws IllegalArgumentException if source is null
+ * @throws IllegalArgumentException if {@code source} is null
*/
public InvocationEvent(Object source, Runnable runnable, Runnable listener,
boolean catchThrowables) {
@@ -243,34 +245,34 @@
}
/**
- * 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.
+ * Constructs an {@code InvocationEvent} with the specified
+ * source and ID which will execute the runnable's {@code run}
+ * method when dispatched. If notifier is non-{@code null},
+ * {@code notifyAll} will be called on it immediately after
+ * {@code run} has returned or thrown an exception.
*
This method throws an
- * IllegalArgumentException if source
- * is null.
+ * {@code IllegalArgumentException} if {@code source}
+ * is {@code null}.
*
- * @param source The Object that originated
+ * @param source The {@code Object} that originated
* the event
* @param id An integer indicating the type of event.
* For information on allowable values, see
* the class description for {@link InvocationEvent}
- * @param runnable The Runnable whose
- * run method will be executed
- * @param notifier The Object whose notifyAll
+ * @param runnable The {@code Runnable} whose
+ * {@code run} method will be executed
+ * @param notifier The {@code Object} whose {@code notifyAll}
* method will be called after
- * Runnable.run has returned or
+ * {@code Runnable.run} has returned or
* thrown an exception or after the event was
* disposed
- * @param catchThrowables Specifies whether dispatch
+ * @param catchThrowables Specifies whether {@code dispatch}
* should catch Throwable when executing the
- * Runnable's run
+ * {@code Runnable}'s {@code run}
* method, or should instead propagate those
* Throwables to the EventDispatchThread's
* dispatch loop
- * @throws IllegalArgumentException if source is null
+ * @throws IllegalArgumentException if {@code source} is null
* @see #getSource()
* @see #getID()
*/
@@ -289,8 +291,8 @@
this.when = System.currentTimeMillis();
}
/**
- * Executes the Runnable's run() method and notifies the
- * notifier (if any) when run() has returned or thrown an exception.
+ * Executes the Runnable's {@code run()} method and notifies the
+ * notifier (if any) when {@code run()} has returned or thrown an exception.
*
* @see #isDispatched
*/
@@ -316,8 +318,8 @@
}
/**
- * Returns any Exception caught while executing the Runnable's run()
- * method.
+ * Returns any Exception caught while executing
+ * the Runnable's {@code run()} method.
*
* @return A reference to the Exception if one was thrown; null if no
* Exception was thrown or if this InvocationEvent does not
@@ -328,8 +330,8 @@
}
/**
- * Returns any Throwable caught while executing the Runnable's run()
- * method.
+ * Returns any Throwable caught while executing
+ * the Runnable's {@code run()} method.
*
* @return A reference to the Throwable if one was thrown; null if no
* Throwable was thrown or if this InvocationEvent does not