blob: b95d4a324d39d7bdd3b1d9fcb909ccae6735b98f [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>README Status Handlers Extension Point</title>
</head>
<body link="#0000FF" vlink="#800080">
<h1 align="center">Status Handlers</h1>
<p><b><i>Identifier: </i></b>org.eclipse.debug.core.statusHandlers</p>
<p><b><i>Description: </i></b>This extension point provides a generic
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 reponsibility to lookup and delegate
to status handlers when an error condition occurrs.</p>
<p><b><i>Configuration Markup:</i></b> </p>
<pre>
<tt>&nbsp;&nbsp; &lt;!ELEMENT statusHandlers</tt>&gt;
<tt>&nbsp;&nbsp; &lt;!ATTLIST statusHandlers</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; plugin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; code&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>&gt;
</pre>
<ul>
<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>
</ul>
<p><b><i>Examples:</i></b> </p>
<p>The following is an example of a status handler extension point: </p>
<pre>
&lt;extension point="org.eclipse.debug.core.statusHandlers"&gt;
&lt;statusHandler
id="com.example.ExampleIdentifier"
class="com.example.ExampleStatusHandler"
plugin="com.example.ExamplePluginId"
code="123"&gt;
&lt;/statusHandler&gt;
&lt;/extension&gt;
</pre>
<p>In the example above, the specified status handler will be registered
to handle status objects with a plug-in identifier of <code>com.example.ExamplePluginId</code>
and a status code of <code>123</code>.
</p>
<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>
<p><a href="hglegal.htm"><img src="ngibmcpy.gif" alt="Copyright IBM Corp. 2000, 2001. All Rights Reserved."
border="0" width="195" height="12"></a></p>
</body>
</html>