| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>SharedObjectFactory (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, class: SharedObjectFactory"> |
| <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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":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 = "../../../../../"; |
| 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/SharedObjectFactory.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> <a href="package-summary.html">org.eclipse.ecf.core.sharedobject</a></div> |
| <h1 title="Class SharedObjectFactory" class="title">Class SharedObjectFactory</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.ecf.core.sharedobject.SharedObjectFactory</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SharedObjectFactory</span> |
| extends <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> |
| implements <a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></pre> |
| <div class="block">Factory for creating <a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObject</code></a> instances. This class provides ECF |
| clients an entry point to constructing <a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObject</code></a> instances. <br></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#instance">instance</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SharedObjectFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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="t1" class="tableTab" onclick="show(1);">Static 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="t4" class="tableTab" onclick="show(8);">Concrete 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>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> description)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>protected <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="#addDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription0</a></span>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> n)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <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>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</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="rowColor" id="i3"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">containsDescription0</a></span>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</code></th> |
| <td class="colLast"> </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(java.lang.String)">createSharedObject</a></span>​(<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> descriptionName)</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="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>​(<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> 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>[] args)</code></th> |
| <td class="colLast"> |
| <div class="block">Create ISharedObject instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <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>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> desc, |
| <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>[] args)</code></th> |
| <td class="colLast"> |
| <div class="block">Create ISharedObject instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>static <a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefault()">getDefault</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>protected <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="#getDescription0(java.lang.String)">getDescription0</a></span>​(<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> name)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>protected <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="#getDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">getDescription0</a></span>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <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>​(<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> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the known SharedObjectTypeDescription given it's name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <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="altColor" id="i12"> |
| <td class="colFirst"><code>protected <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="#getDescriptions0()">getDescriptions0</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <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>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove given description from set known to this factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>protected <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="#removeDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">removeDescription0</a></span>​(<a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> n)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="instance">instance</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType"><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></span> <span class="memberName">instance</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>()">SharedObjectFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName">SharedObjectFactory</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ 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="getDefault()">getDefault</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></span> <span class="memberName">getDefault</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">addDescription</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> description)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#addDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDescriptions()">getDescriptions</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <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> <span class="memberName">getDescriptions</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#getDescriptions()">ISharedObjectFactory</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#getDescriptions()">getDescriptions</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <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="getDescriptions0()">getDescriptions0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <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> <span class="memberName">getDescriptions0</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">addDescription0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">addDescription0</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> n)</span></div> |
| </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="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">containsDescription</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#containsDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">ISharedObjectFactory</a></code></span></div> |
| <div class="block">Check to see if a given named description is already contained by this |
| factory</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#containsDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">containsDescription</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scd</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="containsDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">containsDescription0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">containsDescription0</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">getDescription0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">getDescription0</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDescription0(java.lang.String)">getDescription0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">getDescription0</span>​(<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> name)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDescriptionByName(java.lang.String)">getDescriptionByName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">getDescriptionByName</span>​(<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> 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#getDescriptionByName(java.lang.String)">ISharedObjectFactory</a></code></span></div> |
| <div class="block">Get the known SharedObjectTypeDescription given it's name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#getDescriptionByName(java.lang.String)">getDescriptionByName</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></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="modifiers">public</span> <span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span> <span class="memberName">createSharedObject</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> desc, |
| <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>[] 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#createSharedObject(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription,java.lang.Object%5B%5D)">ISharedObjectFactory</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#createSharedObject(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription,java.lang.Object%5B%5D)">createSharedObject</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>desc</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="modifiers">public</span> <span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span> <span class="memberName">createSharedObject</span>​(<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> 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#createSharedObject(java.lang.String)">ISharedObjectFactory</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#createSharedObject(java.lang.String)">createSharedObject</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <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="modifiers">public</span> <span class="returnType"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></span> <span class="memberName">createSharedObject</span>​(<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> 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>[] 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#createSharedObject(java.lang.String,java.lang.Object%5B%5D)">ISharedObjectFactory</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#createSharedObject(java.lang.String,java.lang.Object%5B%5D)">createSharedObject</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <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="modifiers">public</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">removeDescription</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> scd)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ISharedObjectFactory.html#removeDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">ISharedObjectFactory</a></code></span></div> |
| <div class="block">Remove given description from set known to this factory.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ISharedObjectFactory.html#removeDescription(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">removeDescription</a></code> in interface <code><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></code></dd> |
| <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> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeDescription0(org.eclipse.ecf.core.sharedobject.SharedObjectTypeDescription)">removeDescription0</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></span> <span class="memberName">removeDescription0</span>​(<span class="arguments"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a> n)</span></div> |
| </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/SharedObjectFactory.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
