Google Git
Sign in
eclipse / gerrit / ptp / org.eclipse.ptp / 17f7f1f7e5bcfe7ddc1b86b5c10bab3a6dbde83f / . / core / org.eclipse.ptp.doc.isv / reference / api / org / eclipse / ptp / ems / core / EnvManagerConfigString.html
blob: db571ab8354994a83d0cf12d042f40ba594e1b0e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Tue Jan 21 20:13:53 EST 2020 -->
<title>EnvManagerConfigString (PTP API Specification)</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="dc.created" content="2020-01-21">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EnvManagerConfigString (PTP API Specification)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EnvManagerConfigString.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ptp.ems.core</a></div>
<h2 title="Class EnvManagerConfigString" class="title">Class EnvManagerConfigString</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.ptp.ems.core.EnvManagerConfigString</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">EnvManagerConfigString</span>
extends java.lang.Object
implements <a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></pre>
<div class="block">Provides methods to persist an environment management configuration to a string.
<p>
See <a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core"><code>IEnvManagerConfig</code></a> for a description of the settings that are persisted.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>6.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">EnvManagerConfigString</a></span>()</code></th>
<td class="colLast">
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">EnvManagerConfigString</a></span>&#8203;(java.lang.String&nbsp;configuration)</code></th>
<td class="colLast">
<div class="block">Creates an <a href="EnvManagerConfigString.html" title="class in org.eclipse.ptp.ems.core"><code>EnvManagerConfigString</code></a> from a given configuration string.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigElements()">getConfigElements</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value of a configuration setting containing the list of selected environment configuration elements
(modules/SoftEnv
macros/etc.).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionName()">getConnectionName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value of the connection name configuration setting.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManualConfigText()">getManualConfigText</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value of a configuration setting containing manually-entered configuration commands.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnvMgmtConfigString(java.lang.String)">isEnvMgmtConfigString</a></span>&#8203;(java.lang.String&nbsp;string)</code></th>
<td class="colLast">
<div class="block">Returns true iff <code>string</code> is a valid environment management configuration string</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnvMgmtEnabled()">isEnvMgmtEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value of a configuration setting indicating whether environment management support is enabled for this project.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isManualConfigEnabled()">isManualConfigEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value of a configuration setting indicating whether manually-entered configuration commands should be used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConfigElements(java.util.List)">setConfigElements</a></span>&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;selectedModules)</code></th>
<td class="colLast">
<div class="block">Sets a configuration setting containing the list of selected environment configuration elements (environment modules/SoftEnv
macros/etc.).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectionName(java.lang.String)">setConnectionName</a></span>&#8203;(java.lang.String&nbsp;connectionName)</code></th>
<td class="colLast">
<div class="block">Sets the connection name configuration setting.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnvMgmtEnabled(boolean)">setEnvMgmtEnabled</a></span>&#8203;(boolean&nbsp;enabled)</code></th>
<td class="colLast">
<div class="block">Sets a configuration setting indicating whether environment management support is enabled.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setManualConfig(boolean)">setManualConfig</a></span>&#8203;(boolean&nbsp;enabled)</code></th>
<td class="colLast">
<div class="block">Sets a configuration setting indicating whether manually-entered configuration commands should be used.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setManualConfigText(java.lang.String)">setManualConfigText</a></span>&#8203;(java.lang.String&nbsp;manualConfigText)</code></th>
<td class="colLast">
<div class="block">Sets a configuration setting containing manually-entered configuration commands.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EnvManagerConfigString</h4>
<pre>public&nbsp;EnvManagerConfigString()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EnvManagerConfigString</h4>
<pre>public&nbsp;EnvManagerConfigString&#8203;(java.lang.String&nbsp;configuration)</pre>
<div class="block">Creates an <a href="EnvManagerConfigString.html" title="class in org.eclipse.ptp.ems.core"><code>EnvManagerConfigString</code></a> from a given configuration string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - an environment configuration string, as returned by <a href="#toString()"><code>toString()</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isEnvMgmtConfigString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnvMgmtConfigString</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isEnvMgmtConfigString&#8203;(java.lang.String&nbsp;string)</pre>
<div class="block">Returns true iff <code>string</code> is a valid environment management configuration string</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string</code> - string to test</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff <code>string</code> is a valid environment management configuration string</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="setEnvMgmtEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnvMgmtEnabled</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEnvMgmtEnabled&#8203;(boolean&nbsp;enabled)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#setEnvMgmtEnabled(boolean)">IEnvManagerConfig</a></code></span></div>
<div class="block">Sets a configuration setting indicating whether environment management support is enabled.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#setEnvMgmtEnabled(boolean)">setEnvMgmtEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - <code>true</code> to use a custom set of modules; <code>false</code> to use defaults</dd>
</dl>
</li>
</ul>
<a id="isEnvMgmtEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnvMgmtEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEnvMgmtEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#isEnvMgmtEnabled()">IEnvManagerConfig</a></code></span></div>
<div class="block">Returns the value of a configuration setting indicating whether environment management support is enabled for this project.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#isEnvMgmtEnabled()">isEnvMgmtEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-<code>null</code></dd>
</dl>
</li>
</ul>
<a id="setManualConfig(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setManualConfig</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setManualConfig&#8203;(boolean&nbsp;enabled)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#setManualConfig(boolean)">IEnvManagerConfig</a></code></span></div>
<div class="block">Sets a configuration setting indicating whether manually-entered configuration commands should be used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#setManualConfig(boolean)">setManualConfig</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - <code>true</code> to use a custom set of modules; <code>false</code> to use defaults</dd>
</dl>
</li>
</ul>
<a id="isManualConfigEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isManualConfigEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isManualConfigEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#isManualConfigEnabled()">IEnvManagerConfig</a></code></span></div>
<div class="block">Returns the value of a configuration setting indicating whether manually-entered configuration commands should be used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#isManualConfigEnabled()">isManualConfigEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-<code>null</code></dd>
</dl>
</li>
</ul>
<a id="setManualConfigText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setManualConfigText</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setManualConfigText&#8203;(java.lang.String&nbsp;manualConfigText)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#setManualConfigText(java.lang.String)">IEnvManagerConfig</a></code></span></div>
<div class="block">Sets a configuration setting containing manually-entered configuration commands.
<p>
Note that <code>null</code> is indistinguishable from the empty string: in both cases, <a href="IEnvManagerConfig.html#getManualConfigText()"><code>IEnvManagerConfig.getManualConfigText()</code></a> will
return the empty string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#setManualConfigText(java.lang.String)">setManualConfigText</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
</dl>
</li>
</ul>
<a id="getManualConfigText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManualConfigText</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getManualConfigText()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#getManualConfigText()">IEnvManagerConfig</a></code></span></div>
<div class="block">Returns the value of a configuration setting containing manually-entered configuration commands.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#getManualConfigText()">getManualConfigText</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-<code>null</code></dd>
</dl>
</li>
</ul>
<a id="setConnectionName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectionName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConnectionName&#8203;(java.lang.String&nbsp;connectionName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#setConnectionName(java.lang.String)">IEnvManagerConfig</a></code></span></div>
<div class="block">Sets the connection name configuration setting.
<p>
Note that <code>null</code> is indistinguishable from the empty string: in both cases, <a href="IEnvManagerConfig.html#getConnectionName()"><code>IEnvManagerConfig.getConnectionName()</code></a> will
return the empty string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#setConnectionName(java.lang.String)">setConnectionName</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionName</code> - (may be <code>null</code>)</dd>
</dl>
</li>
</ul>
<a id="getConnectionName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getConnectionName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#getConnectionName()">IEnvManagerConfig</a></code></span></div>
<div class="block">Returns the value of the connection name configuration setting.
<p>
This may return the empty string but will never return <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#getConnectionName()">getConnectionName</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-<code>null</code></dd>
</dl>
</li>
</ul>
<a id="setConfigElements(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigElements</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConfigElements&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;selectedModules)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#setConfigElements(java.util.List)">IEnvManagerConfig</a></code></span></div>
<div class="block">Sets a configuration setting containing the list of selected environment configuration elements (environment modules/SoftEnv
macros/etc.).
<p>
Note that <code>null</code> is indistinguishable from the empty string: in both cases, <a href="IEnvManagerConfig.html#getConfigElements()"><code>IEnvManagerConfig.getConfigElements()</code></a> will
return an empty list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#setConfigElements(java.util.List)">setConfigElements</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>selectedModules</code> - (may be <code>null</code>)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a id="getConfigElements()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConfigElements</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getConfigElements()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IEnvManagerConfig.html#getConfigElements()">IEnvManagerConfig</a></code></span></div>
<div class="block">Returns the value of a configuration setting containing the list of selected environment configuration elements
(modules/SoftEnv
macros/etc.).
<p>
This may return an empty set but will never return <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IEnvManagerConfig.html#getConfigElements()">getConfigElements</a></code>&nbsp;in interface&nbsp;<code><a href="IEnvManagerConfig.html" title="interface in org.eclipse.ptp.ems.core">IEnvManagerConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-<code>null</code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EnvManagerConfigString.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p>
</footer>
</body>
</html>