blob: f41206df655919f92933094ff32f5c91781f1919 [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>Launch Configuration Comparators</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.core.launchConfigurationComparators<p>
<b><i>Description: </i></b>This extension point provides a configurable mechanism for comparing specific attributes of a launch configuration.
In general, launch configuration attributes can be compared for equality via the default implementation of <samp>java.lang.Object.equals(Object)</samp>.
However, attributes that require special handling should implement this extension point.
For example, when an attribute is stored as XML, it is possible that two strings representing an equivalent attribute have different whitespace formatting.<p><b><i>Configuration Markup:</i></b><p>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT extension (launchConfigurationComparator*)&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 launchConfigurationComparator EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST launchConfigurationComparator</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attribute&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - specifies a unique identifier for this extension.</li>
<li><b>attribute</b> - specifies the launch configuration attribute name that this comparator compares.</li>
<li><b>class</b> - specifies a fully-qualified name of a class that implements <samp>java.util.Comparator</samp>.</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a launch configuration comparator extension point:
<p>
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.core.launchConfigurationComparators&quot;</font>&gt;</font>
<font color="#000080">&lt;launchConfigurationComparator
id=<font color="#008000">&quot;com.example.ExampleIdentifier&quot;</font>
attribute=<font color="#008000">&quot;com.example.ExampleAttributeName&quot;</font>
class=<font color="#008000">&quot;com.example.ComparatorImplementation&quot;</font>&gt;</font>
<font color="#000080">&lt;/launchConfigurationComparator&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the example above, the specified type of launch configuration comparator will be consulted when comparing the equality of attributes keyed with name <samp>com.example.ExampleAttributeName</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>java.util.Comparator</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>