blob: 3a7e1e6658e222753d9c73a54d695d1bcdf239d0 [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>ISharedObjectFactory (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.sharedobject, interface: ISharedObjectFactory">
<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};
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/ISharedObjectFactory.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.sharedobject</a></div>
<h1 title="Interface ISharedObjectFactory" class="title">Interface ISharedObjectFactory</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="SharedObjectFactory.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectFactory</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ISharedObjectFactory</span></pre>
<div class="block">Container factory contract <a href="SharedObjectFactory.html" title="class in org.eclipse.ecf.core.sharedobject"><code>SharedObjectFactory</code></a> for default
implementation.</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="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription</a></span>&#8203;(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;description)</code></th>
<td class="colLast">&nbsp;</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="#containsDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">containsDescription</a></span>&#8203;(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;description)</code></th>
<td class="colLast">
<div class="block">Check to see if a given named description is already contained by this
factory</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSharedObject(java.lang.String)">createSharedObject</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;descriptionName)</code></th>
<td class="colLast">
<div class="block">Create ISharedObject instance.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSharedObject(java.lang.String,java.lang.Object%5B%5D)">createSharedObject</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;descriptionName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</code></th>
<td class="colLast">
<div class="block">Create ISharedObject instance.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSharedObject(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription,java.lang.Object%5B%5D)">createSharedObject</a></span>&#8203;(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;typeDescription,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</code></th>
<td class="colLast">
<div class="block">Create ISharedObject instance.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptionByName(java.lang.String)">getDescriptionByName</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get the known SharedObjectTypeDescription given it's name.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptions()">getDescriptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a collection of the SharedObjectTypeDescriptions currently known to
this factory.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">removeDescription</a></span>&#8203;(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;scd)</code></th>
<td class="colLast">
<div class="block">Remove given description from set known to this factory.</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="addDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription</a></h3>
<div class="memberSignature"><span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span>&nbsp;<span class="memberName">addDescription</span>&#8203;(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;description)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getDescriptions()">getDescriptions</a></h3>
<div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a></span>&nbsp;<span class="memberName">getDescriptions</span>()</div>
<div class="block">Get a collection of the SharedObjectTypeDescriptions currently known to
this factory. This allows clients to query the factory to determine what
if any other SharedObjectTypeDescriptions are currently registered with
the factory, and if so, what they are.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of SharedObjectTypeDescription instances. Will not be null.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="containsDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">containsDescription</a></h3>
<div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">containsDescription</span>&#8203;(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;description)</span></div>
<div class="block">Check to see if a given named description is already contained by this
factory</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - the SharedObjectTypeDescription to look for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if description is already known to factory, false otherwise</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getDescriptionByName(java.lang.String)">getDescriptionByName</a></h3>
<div class="memberSignature"><span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span>&nbsp;<span class="memberName">getDescriptionByName</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</span>
throws <span class="exceptions"><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></span></div>
<div class="block">Get the known SharedObjectTypeDescription given it's name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SharedObjectTypeDescription found. Null if description not found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createSharedObject(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription,java.lang.Object[])">createSharedObject</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span>&nbsp;<span class="memberName">createSharedObject</span>&#8203;(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;typeDescription,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</span>
throws <span class="exceptions"><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></span></div>
<div class="block">Create ISharedObject instance. Given a SharedObjectTypeDescription
object, a String [] of argument types, and an Object [] of parameters,
this method will
<p>
<ul>
<li>lookup the known SharedObjectTypeDescriptions to find one of
matching name</li>
<li>if found, will retrieve or create an ISharedObjectInstantiator for
that description</li>
<li>Call the ISharedObjectInstantiator.createInstance method to return
an instance of ISharedObject</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeDescription</code> - the SharedObjectTypeDescription to use to create the instance</dd>
<dd><code>args</code> - an Object [] of arguments passed to the createInstance method
of the ISharedObjectInstantiator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a valid instance of ISharedObject. Will not be null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></code> - if shared object cannot be created</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createSharedObject(java.lang.String)">createSharedObject</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span>&nbsp;<span class="memberName">createSharedObject</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;descriptionName)</span>
throws <span class="exceptions"><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></span></div>
<div class="block">Create ISharedObject instance. Given a SharedObjectTypeDescription name,
this method will
<p>
<ul>
<li>lookup the known SharedObjectTypeDescriptions to find one of
matching name</li>
<li>if found, will retrieve or create an ISharedObjectInstantiator for
that description</li>
<li>Call the ISharedObjectInstantiator.createInstance method to return
an instance of ISharedObject</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>descriptionName</code> - the SharedObjectTypeDescription name to lookup</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a valid instance of ISharedObject. Will not be null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createSharedObject(java.lang.String,java.lang.Object[])">createSharedObject</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span>&nbsp;<span class="memberName">createSharedObject</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;descriptionName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</span>
throws <span class="exceptions"><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></span></div>
<div class="block">Create ISharedObject instance. Given a SharedObjectTypeDescription name,
this method will
<p>
<ul>
<li>lookup the known SharedObjectTypeDescriptions to find one of
matching name</li>
<li>if found, will retrieve or create an ISharedObjectInstantiator for
that description</li>
<li>Call the ISharedObjectInstantiator.createInstance method to return
an instance of ISharedObject</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>descriptionName</code> - the SharedObjectTypeDescription name to lookup</dd>
<dd><code>args</code> - the Object [] of arguments passed to the
ISharedObjectInstantiator.createInstance method</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a valid instance of IContainer. Will not be null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">removeDescription</a></h3>
<div class="memberSignature"><span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span>&nbsp;<span class="memberName">removeDescription</span>&#8203;(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a>&nbsp;scd)</span></div>
<div class="block">Remove given description from set known to this factory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scd</code> - the SharedObjectTypeDescription to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the removed SharedObjectTypeDescription, null if nothing removed</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/ISharedObjectFactory.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>