blob: b60ee22300ad3dd5699240bc17d3346131b7c71f [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 Launch Configuration Types Extension Point</title>
</head>
<body link="#0000FF" vlink="#800080">
<h1 align="center">Launch Configuration Comparators</h1>
<p><b><i>Identifier: </i></b>org.eclipse.debug.core.launchConfigurationComparators</p>
<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 <code>java.lang.Object.equals(Object)</code>. 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>
<p><b><i>Configuration Markup:</i></b> </p>
<pre>
<tt>&nbsp;&nbsp; &lt;!ELEMENT launchConfigurationComparator</tt>&gt;
<tt>&nbsp;&nbsp; &lt;!ATTLIST launchConfigurationComparator</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attribute&nbsp; CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</tt>
</pre>
<ul>
<li><code>id</code> specifies a unique identifier for this extension.</li>
<li><code>attribute</code> specifies the launch configuration attribute name that this comparator
compares</li>
<li><code>class</code> specifies a fully qualified name of a class that
implements <code>java.util.Comparator</code></li>
</ul>
<p><b><i>Examples:</i></b> </p>
<p>The following is an example of a launch configuration comparator extension point: </p>
<pre>
&lt;extension point="org.eclipse.debug.core.launchConfigurationComparators"&gt;
&lt;launchConfigurationComparator
id="com.example.ExampleIdentifier"
attribute="com.example.ExampleAttributeName"
class="com.example.ComapartorImplementation"&gt;
&lt;/launchConfigurationComparator&gt;
&lt;/extension&gt;
</pre>
<p>In the example above, the specified type of launch configuration comparator will be
consulted when comparing the equality of attributes keyed with the name
<code>com.example.ExampleAttributeName</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>
java.util.Comparator</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>