blob: 2955233c9087924e7c066b44d916264ac762fe64 [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">
</HEAD>
<HTML>
<BODY>
<H1><CENTER>Console Line Trackers</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.ui.consoleLineTrackers<p>
<b><i>Since: </i></b>2.1<p>
<b><i>Description: </i></b>This extension point provides a mechanism to listen to console output for a type of process.<p><b><i>Configuration Markup:</i></b><p>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT extension EMPTY&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 consoleLineTracker EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST consoleLineTracker</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;processType&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - specifies a unique identifier for this console line tracker.</li>
<li><b>class</b> - specifies a fully qualified name of a Java class that implements IConsoleLineTracker</li>
<li><b>processType</b> - specifies the type of process this line tracker is for. This attribute corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE.</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a console line tracker extension point:
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.ui.consoleLineTrackers&quot;</font>&gt;</font>
<font color="#000080">&lt;consoleLineTracker
id=<font color="#008000">&quot;com.example.ExampleConsoleLineTracker&quot;</font>
class=<font color="#008000">&quot;com.example.ExampleConsoleLineTracker&quot;</font>
processType=<font color="#008000">&quot;ExampleProcessType&quot;</font>&gt;</font>
<font color="#000080">&lt;/consoleLineTracker&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
In the above example, the contributed line tracker will be notified as lines are appended to the console for processes of type "ExampleProcessType", which corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE. Process types are client defined, and are set by clients that create processes.<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.ui.console.IConsoleLineTracker</b>.<p>
<font size="-1" color="#336699">
<a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a><p>
</font>
</BODY>
</HTML>