blob: fd0f7b8d0b31d69452dc96a1a1ecc6de77e1b470 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
<title>IContainerManager (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="dc.created" content="2021-06-15">
<meta name="description" content="declaration: package: org.eclipse.ecf.core, interface: IContainerManager">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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 = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= 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/IContainerManager.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>
<div class="subNav">
<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>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.core</a></div>
<h1 title="Interface IContainerManager" class="title">Interface IContainerManager</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="ContainerFactory.html" title="class in org.eclipse.ecf.core">ContainerFactory</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IContainerManager</span></pre>
<div class="block">Container manager for getting access to existing container instances
previously created via <a href="IContainerFactory.html" title="interface in org.eclipse.ecf.core"><code>IContainerFactory</code></a>.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<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>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addContainer(org.eclipse.ecf.core.IContainer,org.eclipse.ecf.core.ContainerTypeDescription)">addContainer</a></span>&#8203;(<a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>&nbsp;container,
<a href="ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a>&nbsp;typeDescription)</code></th>
<td class="colLast">
<div class="block">Add given container to manager.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addListener(org.eclipse.ecf.core.IContainerManagerListener)">addListener</a></span>&#8203;(<a href="IContainerManagerListener.html" title="interface in org.eclipse.ecf.core">IContainerManagerListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Add listener to this <a href="IContainerManager.html" title="interface in org.eclipse.ecf.core"><code>IContainerManager</code></a>.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllContainers()">getAllContainers</a></span>()</code></th>
<td class="colLast">
<div class="block">Get all containers known to this container manager.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainer(org.eclipse.ecf.core.identity.ID)">getContainer</a></span>&#8203;(<a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</code></th>
<td class="colLast">
<div class="block">Get container for given ID.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="IContainerFactory.html" title="interface in org.eclipse.ecf.core">IContainerFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainerFactory()">getContainerFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Get container factory associated with this container manager.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainerTypeDescription(org.eclipse.ecf.core.identity.ID)">getContainerTypeDescription</a></span>&#8203;(<a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</code></th>
<td class="colLast">
<div class="block">Get the container type description used to create the container with the given ID.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasContainer(org.eclipse.ecf.core.identity.ID)">hasContainer</a></span>&#8203;(<a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</code></th>
<td class="colLast">
<div class="block">Return true if this container manager has the given container under
management, false otherwise.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllContainers()">removeAllContainers</a></span>()</code></th>
<td class="colLast">
<div class="block">Remove all containers from this manager</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeContainer(org.eclipse.ecf.core.IContainer)">removeContainer</a></span>&#8203;(<a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>&nbsp;container)</code></th>
<td class="colLast">
<div class="block">Remove given container from manager.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeContainer(org.eclipse.ecf.core.identity.ID)">removeContainer</a></span>&#8203;(<a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</code></th>
<td class="colLast">
<div class="block">Remove given container from manager.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeListener(org.eclipse.ecf.core.IContainerManagerListener)">removeListener</a></span>&#8203;(<a href="IContainerManagerListener.html" title="interface in org.eclipse.ecf.core">IContainerManagerListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Remove listener from this <a href="IContainerManager.html" title="interface in org.eclipse.ecf.core"><code>IContainerManager</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getContainerFactory()">getContainerFactory</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainerFactory.html" title="interface in org.eclipse.ecf.core">IContainerFactory</a></span>&nbsp;<span class="memberName">getContainerFactory</span>()</div>
<div class="block">Get container factory associated with this container manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainerFactory. Will not return <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getContainer(org.eclipse.ecf.core.identity.ID)">getContainer</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></span>&nbsp;<span class="memberName">getContainer</span>&#8203;(<span class="arguments"><a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</span></div>
<div class="block">Get container for given ID. If <code>containerID</code> is
<code>null</code> then <code>null</code> will be returned. If
active container with given <code>containerID,</code> is not known to this container manager,
then <code>null</code> will also be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerID</code> - the ID of the container instance to retrieve from this manager. If <code>null</code>
<code>null</code> will be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainer instance with given <code>containerID</code>. Will be <code>null</code> if there
is no container with given ID known to this container manager.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getContainerTypeDescription(org.eclipse.ecf.core.identity.ID)">getContainerTypeDescription</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a></span>&nbsp;<span class="memberName">getContainerTypeDescription</span>&#8203;(<span class="arguments"><a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</span></div>
<div class="block">Get the container type description used to create the container with the given ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerID</code> - the ID of the container to get the description for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ContainerTypeDescription for the container with the given ID. Will return <code>null</code>
if no container with the given containerID exists under this manager.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getAllContainers()">getAllContainers</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>[]</span>&nbsp;<span class="memberName">getAllContainers</span>()</div>
<div class="block">Get all containers known to this container manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainer[] of active container instances known to this
container manager. Will not return <code>null</code>, but may
return empty IContainer[].</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="hasContainer(org.eclipse.ecf.core.identity.ID)">hasContainer</a></h3>
<div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">hasContainer</span>&#8203;(<span class="arguments"><a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</span></div>
<div class="block">Return true if this container manager has the given container under
management, false otherwise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerID</code> - the ID of the container to find. If <code>null</code> this
method returns false.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this container manager has the given container under
management, false otherwise.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="addContainer(org.eclipse.ecf.core.IContainer,org.eclipse.ecf.core.ContainerTypeDescription)">addContainer</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></span>&nbsp;<span class="memberName">addContainer</span>&#8203;(<span class="arguments"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>&nbsp;container,
<a href="ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a>&nbsp;typeDescription)</span></div>
<div class="block">Add given container to manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - to add. Must not be <code>null</code>. Also
<code>container.getID()</code> must return a non-<code>null</code>
value. If <code>container.getID()</code> returns
<code>null</code> then this method will throw a
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>NullPointerException</code></a>.</dd>
<dd><code>typeDescription</code> - the container type description used to create the given container. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainer previously added (with same ID).</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeContainer(org.eclipse.ecf.core.IContainer)">removeContainer</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></span>&nbsp;<span class="memberName">removeContainer</span>&#8203;(<span class="arguments"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a>&nbsp;container)</span></div>
<div class="block">Remove given container from manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - the container to remove. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainer instance removed. If no instance with same ID is found
then <code>null</code> will be returned.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeContainer(org.eclipse.ecf.core.identity.ID)">removeContainer</a></h3>
<div class="memberSignature"><span class="returnType"><a href="IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></span>&nbsp;<span class="memberName">removeContainer</span>&#8203;(<span class="arguments"><a href="identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;containerID)</span></div>
<div class="block">Remove given container from manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerID</code> - the ID of the container to remove. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IContainer instance removed. If no instance with same ID is found
then <code>null</code> will be returned.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="addListener(org.eclipse.ecf.core.IContainerManagerListener)">addListener</a></h3>
<div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">addListener</span>&#8203;(<span class="arguments"><a href="IContainerManagerListener.html" title="interface in org.eclipse.ecf.core">IContainerManagerListener</a>&nbsp;listener)</span></div>
<div class="block">Add listener to this <a href="IContainerManager.html" title="interface in org.eclipse.ecf.core"><code>IContainerManager</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to add. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if listener successfully added</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeListener(org.eclipse.ecf.core.IContainerManagerListener)">removeListener</a></h3>
<div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">removeListener</span>&#8203;(<span class="arguments"><a href="IContainerManagerListener.html" title="interface in org.eclipse.ecf.core">IContainerManagerListener</a>&nbsp;listener)</span></div>
<div class="block">Remove listener from this <a href="IContainerManager.html" title="interface in org.eclipse.ecf.core"><code>IContainerManager</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to remove. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if listener successfully removed</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeAllContainers()">removeAllContainers</a></h3>
<div class="memberSignature"><span class="returnType">void</span>&nbsp;<span class="memberName">removeAllContainers</span>()</div>
<div class="block">Remove all containers from this manager</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<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/IContainerManager.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>
<div class="subNav">
<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>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>