Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java')
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java49
1 files changed, 26 insertions, 23 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
index 601496a27..b955afa00 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
@@ -18,24 +18,25 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
/**
- * A status handler registers to handle a specific status - error
- * or otherwise. Provides a mechanism for separating core (headless)
- * function from UI interaction. The debug plug-in provides a
- * status handlers extension point, against which handlers can
- * register for specific status codes - identified by plug-in
- * identifier and plug-in specific status code. The interaction between
- * an object requiring a status handler (source), and the status handler
- * is defined by the source and handler.
+ * A status handler registers to handle a specific status - error or otherwise.
+ * Provides a mechanism for separating core (headless) function from UI
+ * interaction. The debug plug-in provides a status handlers extension point,
+ * against which handlers can register for specific status codes - identified by
+ * plug-in identifier and plug-in specific status code. The interaction between
+ * an object requiring a status handler (source), and the status handler is
+ * defined by the source and handler.
* <p>
- * For example, a launch configuration delegate might encounter a timeout
- * while launching an application. In this case the delegate could abort
- * or, via the use of a status handler, prompt the user to continue. This
- * allows the launcher to be implemented in a plug-in that does not require
- * UI support, and allows another (UI) plug-in to register a handler.
+ * For example, a launch configuration delegate might encounter a timeout while
+ * launching an application. In this case the delegate could abort or, via the
+ * use of a status handler, prompt the user to continue. This allows the
+ * launcher to be implemented in a plug-in that does not require UI support, and
+ * allows another (UI) plug-in to register a handler.
* </p>
* <p>
- * A status handler extension is defined in <code>plugin.xml</code>.
- * Following is an example definition of a status handler extension.
+ * A status handler extension is defined in <code>plugin.xml</code>. Following
+ * is an example definition of a status handler extension.
+ * </p>
+ *
* <pre>
* &lt;extension point="org.eclipse.debug.core.statusHandlers"&gt;
* &lt;statusHandler
@@ -46,21 +47,23 @@ import org.eclipse.core.runtime.IStatus;
* &lt;/statusHandler&gt;
* &lt;/extension&gt;
* </pre>
+ *
* The attributes are specified as follows:
* <ul>
- * <li><code>id</code> specifies a unique identifier for this status handler.</li>
+ * <li><code>id</code> specifies a unique identifier for this status
+ * handler.</li>
* <li><code>class</code> specifies the fully qualified name of the Java class
- * that implements <code>IStatusHandler</code>.</li>
- * <li><code>plugin</code> plug-in identifier that corresponds to the
- * plug-in of the status this handler is registered for (i.e.
- * <code>IStatus.getPlugin()</code>).</li>
- * <li><code>code</code> specifies the status code this handler
- * is registered for.</li>
+ * that implements <code>IStatusHandler</code>.</li>
+ * <li><code>plugin</code> plug-in identifier that corresponds to the plug-in of
+ * the status this handler is registered for (i.e.
+ * <code>IStatus.getPlugin()</code>).</li>
+ * <li><code>code</code> specifies the status code this handler is registered
+ * for.</li>
* </ul>
- * </p>
* <p>
* Clients may implement this interface.
* </p>
+ *
* @see DebugPlugin#getStatusHandler(IStatus)
* @since 2.0
*/

Back to the top