blob: 55a8258301d3333ad622e3c21b87bc0749ed4d73 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>LaunchTask (Oomph Setup Documentation)</title>
<meta name="date" content="">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LaunchTask (Oomph Setup Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LaunchTask.html">Use</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchingPlugin.Implementation.html" title="class in org.eclipse.oomph.setup.launching"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/oomph/setup/launching/LaunchTask.html" target="_top">Frames</a></li>
<li><a href="LaunchTask.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.oomph.setup.launching</div>
<h2 title="Interface LaunchTask" class="title">Interface LaunchTask</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>, <a href="../../../../../../../org.eclipse.oomph.util.doc/javadoc/org/eclipse/oomph/base/ModelElement.html?is-external=true" title="class or interface in org.eclipse.oomph.base">ModelElement</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true" title="class or interface in org.eclipse.emf.common.notify">Notifier</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html" title="interface in org.eclipse.oomph.setup">SetupTask</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/oomph/setup/launching/impl/LaunchTaskImpl.html" title="class in org.eclipse.oomph.setup.launching.impl">LaunchTaskImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">LaunchTask</span>
extends <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html" title="interface in org.eclipse.oomph.setup">SetupTask</a></pre>
<div class="block"><!-- begin-user-doc -->
A representation of the model object '<em><b>Launch Task</b></em>'.
<!-- end-user-doc -->
<p>
The following features are supported:
<ul>
<li><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#getLauncher()"><code><em>Launcher</em></code></a></li>
</ul>
</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchingPackage.html#getLaunchTask()"><code>LaunchingPackage.getLaunchTask()</code></a></dd><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>annotation="http://www.eclipse.org/oomph/setup/ValidTriggers triggers='STARTUP MANUAL'"</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.eclipse.oomph.setup.SetupTask">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.oomph.setup.<a href="../../../../../org/eclipse/oomph/setup/SetupTask.html" title="interface in org.eclipse.oomph.setup">SetupTask</a></h3>
<code><a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_CONFIGURATION">PRIORITY_CONFIGURATION</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_DEFAULT">PRIORITY_DEFAULT</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_EARLY">PRIORITY_EARLY</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_INSTALLATION">PRIORITY_INSTALLATION</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_LATE">PRIORITY_LATE</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#PRIORITY_REDIRECTION">PRIORITY_REDIRECTION</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#getLauncher()">getLauncher</a></strong>()</code>
<div class="block">Returns the value of the '<em><b>Launcher</b></em>' attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#setLauncher(java.lang.String)">setLauncher</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Sets the value of the '<a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#getLauncher()"><code><em>Launcher</em></code></a>' attribute.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.oomph.setup.SetupTask">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.oomph.setup.<a href="../../../../../org/eclipse/oomph/setup/SetupTask.html" title="interface in org.eclipse.oomph.setup">SetupTask</a></h3>
<code><a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#consolidate()">consolidate</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#dispose()">dispose</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getDescription()">getDescription</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getExcludedTriggers()">getExcludedTriggers</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getID()">getID</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getOverrideToken()">getOverrideToken</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getPredecessors()">getPredecessors</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getPriority()">getPriority</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getRestrictions()">getRestrictions</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getScope()">getScope</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getScopeType()">getScopeType</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getSuccessors()">getSuccessors</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getTriggers()">getTriggers</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#getValidTriggers()">getValidTriggers</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#isDisabled()">isDisabled</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#isNeeded(org.eclipse.oomph.setup.SetupTaskContext)">isNeeded</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#overrideFor(org.eclipse.oomph.setup.SetupTask)">overrideFor</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#perform(org.eclipse.oomph.setup.SetupTaskContext)">perform</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#requires(org.eclipse.oomph.setup.SetupTask)">requires</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#setDisabled(boolean)">setDisabled</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#setExcludedTriggers(java.util.Set)">setExcludedTriggers</a>, <a href="../../../../../org/eclipse/oomph/setup/SetupTask.html#setID(java.lang.String)">setID</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.oomph.base.ModelElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.oomph.base.<a href="../../../../../../../org.eclipse.oomph.util.doc/javadoc/org/eclipse/oomph/base/ModelElement.html?is-external=true" title="class or interface in org.eclipse.oomph.base">ModelElement</a></h3>
<code><a href="../../../../../../../org.eclipse.oomph.util.doc/javadoc/org/eclipse/oomph/base/ModelElement.html?is-external=true#getAnnotation(java.lang.String)" title="class or interface in org.eclipse.oomph.base">getAnnotation</a>, <a href="../../../../../../../org.eclipse.oomph.util.doc/javadoc/org/eclipse/oomph/base/ModelElement.html?is-external=true#getAnnotations()" title="class or interface in org.eclipse.oomph.base">getAnnotations</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.emf.ecore.EObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.ecore.<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a></h3>
<code><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eAllContents()" title="class or interface in org.eclipse.emf.ecore">eAllContents</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eClass()" title="class or interface in org.eclipse.emf.ecore">eClass</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainer()" title="class or interface in org.eclipse.emf.ecore">eContainer</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainingFeature()" title="class or interface in org.eclipse.emf.ecore">eContainingFeature</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainmentFeature()" title="class or interface in org.eclipse.emf.ecore">eContainmentFeature</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContents()" title="class or interface in org.eclipse.emf.ecore">eContents</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eCrossReferences()" title="class or interface in org.eclipse.emf.ecore">eCrossReferences</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eGet(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eGet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eGet(org.eclipse.emf.ecore.EStructuralFeature,%20boolean)" title="class or interface in org.eclipse.emf.ecore">eGet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eInvoke(org.eclipse.emf.ecore.EOperation,%20org.eclipse.emf.common.util.EList)" title="class or interface in org.eclipse.emf.ecore">eInvoke</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eIsProxy()" title="class or interface in org.eclipse.emf.ecore">eIsProxy</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eIsSet(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eIsSet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eResource()" title="class or interface in org.eclipse.emf.ecore">eResource</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eSet(org.eclipse.emf.ecore.EStructuralFeature,%20java.lang.Object)" title="class or interface in org.eclipse.emf.ecore">eSet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eUnset(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eUnset</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.emf.common.notify.Notifier">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.common.notify.<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true" title="class or interface in org.eclipse.emf.common.notify">Notifier</a></h3>
<code><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eAdapters()" title="class or interface in org.eclipse.emf.common.notify">eAdapters</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eDeliver()" title="class or interface in org.eclipse.emf.common.notify">eDeliver</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eNotify(org.eclipse.emf.common.notify.Notification)" title="class or interface in org.eclipse.emf.common.notify">eNotify</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eSetDeliver(boolean)" title="class or interface in org.eclipse.emf.common.notify">eSetDeliver</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLauncher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLauncher</h4>
<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLauncher()</pre>
<div class="block">Returns the value of the '<em><b>Launcher</b></em>' attribute.
<!-- begin-user-doc -->
<p>
If the meaning of the '<em>Launcher</em>' attribute isn't clear,
there really should be more of a description here...
</p>
<!-- end-user-doc --></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of the '<em>Launcher</em>' attribute.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#setLauncher(java.lang.String)"><code>setLauncher(String)</code></a>,
<a href="../../../../../org/eclipse/oomph/setup/launching/LaunchingPackage.html#getLaunchTask_Launcher()"><code>LaunchingPackage.getLaunchTask_Launcher()</code></a></dd><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>required="true"</dd></dl>
</li>
</ul>
<a name="setLauncher(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setLauncher</h4>
<pre>void&nbsp;setLauncher(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Sets the value of the '<a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#getLauncher()"><code><em>Launcher</em></code></a>' attribute.
<!-- begin-user-doc -->
<!-- end-user-doc --></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the new value of the '<em>Launcher</em>' attribute.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchTask.html#getLauncher()"><code>getLauncher()</code></a></dd><dt><span class="strong">Generated</span></dt>
<dd></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LaunchTask.html">Use</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/oomph/setup/launching/LaunchingPlugin.Implementation.html" title="class in org.eclipse.oomph.setup.launching"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/oomph/setup/launching/LaunchTask.html" target="_top">Frames</a></li>
<li><a href="LaunchTask.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i class="copyright">Copyright (c) 2014 Eike Stepper (Loehne, Germany) and others.<br>All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v20.html</i></small></p>
</body>
</html>