blob: 94e2e1630004e5d94506d310e576f4a49d5218ea [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
div.dtd-fragment {
width: 100%;
border: none;
background-color: #eee;
}
</STYLE>
</HEAD>
<HTML>
<BODY>
<H1><CENTER>Status Handlers</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.core.statusHandlers<p>
<b><i>Description: </i></b>This extension point provides a mechanism for separating the generation and resolution of an error.
The interaction between the source of the error and the resolution is client-defined.
It is a client responsibility to look up and delegate to status handlers when an error condition occurs.<p><b><i>Configuration Markup:</i></b><p>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.statusHandler">statusHandler</a>*)&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST extension</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT <a name="e.statusHandler">statusHandler</a> EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST statusHandler</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;plugin&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;code&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - specifies a unique identifier for this status handler.</li>
<li><b>class</b> - specifies the fully qualified name of the Java class that implements IStatusHandler.</li>
<li><b>plugin</b> - Plug-in identifier that corresponds to the plug-in of the status this handler is registered for. (i.e. IStatus.getPlugin()).</li>
<li><b>code</b> - specifies the status code this handler is registered for.</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a status handler extension point:
<p>
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.core.statusHandlers&quot;</font>&gt;</font>
<font color="#000080">&lt;statusHandler
id=<font color="#008000">&quot;com.example.ExampleIdentifier&quot;</font>
class=<font color="#008000">&quot;com.example.ExampleStatusHandler&quot;</font>
plugin=<font color="#008000">&quot;com.example.ExamplePluginId&quot;</font>
code=<font color="#008000">&quot;123&quot;</font>&gt;</font>
<font color="#000080">&lt;/statusHandler&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the example above, the specified status handler will be registered for to handle status objects with a plug-in identifier of
<samp>com.example.ExamplePluginId</samp> and a status code of <samp>123</samp>.<p>
<b><i>API Information: </i></b>Value of the attribute <b>class</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.debug.core.IStatusHandler</b>.<p>
<font size="-1" color="#336699">
<p>
<a href="hglegal.htm">
<img SRC="ngibmcpy.gif"
ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved."
BORDER=0 height=14 width=324></a>
</p><p>
</font>
</BODY>
</HTML>