| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.5) on Tue Jan 21 20:13:53 EST 2020 --> |
| <title>IEnvManagerConfig (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="IEnvManagerConfig (PTP API Specification)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IEnvManagerConfig.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.eclipse.ptp.ems.core</a></div> |
| <h2 title="Interface IEnvManagerConfig" class="title">Interface IEnvManagerConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="EnvManagerConfigString.html" title="class in org.eclipse.ptp.ems.core">EnvManagerConfigString</a></code>, <code><a href="EnvManagerProjectProperties.html" title="class in org.eclipse.ptp.ems.core">EnvManagerProjectProperties</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IEnvManagerConfig</span></pre> |
| <div class="block">A configuration of an environment management system. |
| <p> |
| The following configuration settings are persisted. |
| <ul> |
| <li><b>Enablement.</b> This is true iff custom environment manager settings should be used (i.e., a custom set of environment |
| modules or SoftEnv macros should be used, rather than the defaults). |
| <li><b>A list of configuration elements.</b> These are the names of the modules/SoftEnv macros/etc. that should be loaded (if |
| enabled). |
| <li><b>A connection name.</b> This is the name of the connection for which this configuration was constructed. This is used |
| exclusively for sanity checking: if the stored connection name is different than the actual connection name, then the stored |
| configuration is probably for a different machine, and so the configuration is probably incomplete or invalid for the actual |
| machine. |
| </ul></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"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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<java.lang.String></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>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="i4" class="altColor"> |
| <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="i5" class="rowColor"> |
| <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>​(java.util.List<java.lang.String> 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="i6" class="altColor"> |
| <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>​(java.lang.String connectionName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the connection name configuration setting.</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="#setEnvMgmtEnabled(boolean)">setEnvMgmtEnabled</a></span>​(boolean 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="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setManualConfig(boolean)">setManualConfig</a></span>​(boolean 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="i9" class="rowColor"> |
| <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>​(java.lang.String manualConfigText)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a configuration setting containing manually-entered configuration commands.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setEnvMgmtEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnvMgmtEnabled</h4> |
| <pre class="methodSignature">void setEnvMgmtEnabled​(boolean enabled)</pre> |
| <div class="block">Sets a configuration setting indicating whether environment management support is enabled.</div> |
| <dl> |
| <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">boolean isEnvMgmtEnabled()</pre> |
| <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="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">void setManualConfig​(boolean enabled)</pre> |
| <div class="block">Sets a configuration setting indicating whether manually-entered configuration commands should be used.</div> |
| <dl> |
| <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">boolean isManualConfigEnabled()</pre> |
| <div class="block">Returns the value of a configuration setting indicating whether manually-entered configuration commands should be used.</div> |
| <dl> |
| <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">void setManualConfigText​(java.lang.String manualConfigText)</pre> |
| <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="#getManualConfigText()"><code>getManualConfigText()</code></a> will |
| return the empty string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>manualConfigText</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getManualConfigText()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManualConfigText</h4> |
| <pre class="methodSignature">java.lang.String getManualConfigText()</pre> |
| <div class="block">Returns the value of a configuration setting containing manually-entered configuration commands.</div> |
| <dl> |
| <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">void setConfigElements​(java.util.List<java.lang.String> selectedModules)</pre> |
| <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="#getConfigElements()"><code>getConfigElements()</code></a> will |
| return an empty list.</div> |
| <dl> |
| <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="blockList"> |
| <li class="blockList"> |
| <h4>getConfigElements</h4> |
| <pre class="methodSignature">java.util.List<java.lang.String> getConfigElements()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>non-<code>null</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConnectionName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionName</h4> |
| <pre class="methodSignature">void setConnectionName​(java.lang.String connectionName)</pre> |
| <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="#getConnectionName()"><code>getConnectionName()</code></a> will |
| return the empty string.</div> |
| <dl> |
| <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="blockListLast"> |
| <li class="blockList"> |
| <h4>getConnectionName</h4> |
| <pre class="methodSignature">java.lang.String getConnectionName()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>non-<code>null</code></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/IEnvManagerConfig.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |