blob: 3584ad541b8370c574986b70cba42d91107bea60 [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>Simple Launch Variables</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.core.simpleLaunchVariables<p>
<b><i>Since: </i></b>3.0<p>
<b><i>Description: </i></b>This extension point provides a mechanism for defining simple launch configuration variables. A simple launch variable is a key/value pair (of strings) that can be used as an attribute value in a launch configuration which supports variable expansion.<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.variable">variable</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.variable">variable</a> EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST variable</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;initialValue&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;initializerClass&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>name</b> - specifies a unique name for this variable.</li>
<li><b>initialValue</b> - specifies the initial value for this variable. When specified, an <samp>initializerClass</samp> attribute must not be specified.</li>
<li><b>initializerClass</b> - specifies the fully qualified name of the Java class that implements <samp>org.eclipse.debug.core.variables.ILaunchVariableInitializer</samp>. When specified, an <samp>initialValue</samp> attribute must not be specified.</li>
<li><b>description</b> - specifies a human-readable description of this variable</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a launch configuration variable extension point with an initial value:
<p>
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.core.simpleLaunchVariables&quot;</font>&gt;</font>
<font color="#000080">&lt;variable
name=<font color="#008000">&quot;FOO_HOME&quot;</font>
initialValue=<font color="#008000">&quot;/usr/local/foo&quot;</font>&gt;</font>
<font color="#000080">&lt;/variable&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the example above, the specified variable is created with the initial value "/usr/local/foo".
The following is an example of a launch configuration variable extension point with an initializer class:
<p>
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.core.simpleLaunchVariables&quot;</font>&gt;</font>
<font color="#000080">&lt;variable
name=<font color="#008000">&quot;FOO_HOME&quot;</font>
initializerClass=<font color="#008000">&quot;com.example.FooLocator&quot;</font>&gt;</font>
<font color="#000080">&lt;/variable&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the example above, the variable FOO_HOME is created and the class "com.example.FooLocator" will be
used to initialize the value the first time it's requested.<p>
<b><i>API Information: </i></b>Value of the attribute <b>initializerClass</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.debug.core.variables.IVariableInitializer</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>