| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IContainerInstantiator (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.provider, interface: IContainerInstantiator"> |
| <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}; |
| 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/IContainerInstantiator.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>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> |
| <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.provider</a></div> |
| <h1 title="Interface IContainerInstantiator" class="title">Interface IContainerInstantiator</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../BaseContainer.Instantiator.html" title="class in org.eclipse.ecf.core">BaseContainer.Instantiator</a></code>, <code><a href="BaseContainerInstantiator.html" title="class in org.eclipse.ecf.core.provider">BaseContainerInstantiator</a></code>, <code><a href="BaseRemoteServiceContainerInstantiator.html" title="class in org.eclipse.ecf.core.provider">BaseRemoteServiceContainerInstantiator</a></code>, <code><a href="../../provider/dnssd/ContainerInstantiator.html" title="class in org.eclipse.ecf.provider.dnssd">ContainerInstantiator</a></code>, <code><a href="../../provider/jslp/container/ContainerInstantiator.html" title="class in org.eclipse.ecf.provider.jslp.container">ContainerInstantiator</a></code>, <code><a href="../../provider/generic/GenericContainerInstantiator.html" title="class in org.eclipse.ecf.provider.generic">GenericContainerInstantiator</a></code>, <code><a href="../../remoteservice/provider/PeerRemoteServiceContainerInstantiator.html" title="class in org.eclipse.ecf.remoteservice.provider">PeerRemoteServiceContainerInstantiator</a></code>, <code><a href="../../remoteservice/provider/RemoteServiceContainerInstantiator.html" title="class in org.eclipse.ecf.remoteservice.provider">RemoteServiceContainerInstantiator</a></code>, <code><a href="../../remoteservice/rest/client/RestClientContainerInstantiator.html" title="class in org.eclipse.ecf.remoteservice.rest.client">RestClientContainerInstantiator</a></code>, <code><a href="../../remoteservice/servlet/ServletServerContainerInstantiator.html" title="class in org.eclipse.ecf.remoteservice.servlet">ServletServerContainerInstantiator</a></code>, <code><a href="../../provider/generic/SSLGenericContainerInstantiator.html" title="class in org.eclipse.ecf.provider.generic">SSLGenericContainerInstantiator</a></code>, <code><a href="../../provider/zookeeper/core/ZooDiscoveryContainerInstantiator.html" title="class in org.eclipse.ecf.provider.zookeeper.core">ZooDiscoveryContainerInstantiator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IContainerInstantiator</span></pre> |
| <div class="block">Interface that must be implemented by ECF provider implementations.</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="#createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object%5B%5D)">createInstance</a></span>​(<a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description, |
| <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>[] parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Create instance of IContainer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSupportedAdapterTypes(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedAdapterTypes</a></span>​(<a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Get array of supported adapters for the given container type description.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSupportedIntents(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedIntents</a></span>​(<a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>[][]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSupportedParameterTypes(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedParameterTypes</a></span>​(<a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Get array of parameter types for given container type description.</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="createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object[])">createInstance</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></span> <span class="memberName">createInstance</span>​(<span class="arguments"><a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description, |
| <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>[] parameters)</span> |
| throws <span class="exceptions"><a href="../ContainerCreateException.html" title="class in org.eclipse.ecf.core">ContainerCreateException</a></span></div> |
| <div class="block">Create instance of IContainer. This is the interface that container |
| provider implementations must implement for the containerFactory |
| extension point. The caller may optionally specify both argument types |
| and arguments that will be passed into this method (and therefore to the |
| provider implementation implementing this method). For example: |
| <p> |
| <b> ContainerFactory.getDefault().createContainer("foocontainer",new |
| Object { "hello" });</b> |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the ContainerTypeDescription associated with the registered |
| container provider implementation</dd> |
| <dd><code>parameters</code> - parameters specified by the caller. May be null if no |
| parameters are passed in by caller to |
| ContainerFactory.getDefault().createContainer(...)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IContainer instance. The provider implementation must return a |
| valid object implementing IContainer OR throw a |
| ContainerCreateException. Null will not be returned.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ContainerCreateException.html" title="class in org.eclipse.ecf.core">ContainerCreateException</a></code> - thrown if instance cannot be created</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSupportedAdapterTypes(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedAdapterTypes</a></h3> |
| <div class="memberSignature"><span class="returnType"><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>[]</span> <span class="memberName">getSupportedAdapterTypes</span>​(<span class="arguments"><a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</span></div> |
| <div class="block">Get array of supported adapters for the given container type description. |
| Providers implement this method to allow clients to inspect the adapter |
| types exposed by the container described by the given description. |
| |
| The returned array entries will be the fully qualified names of the |
| adapter classes. |
| |
| Note that the returned types do not guarantee that a subsequent call to |
| <a href="../IContainer.html#getAdapter(java.lang.Class)"><code>IContainer.getAdapter(Class)</code></a> with the same type name as a |
| returned value will return a non-<code>null</code> result. In other |
| words, even if the class name is in the returned array, subsequent calls |
| to <a href="../IContainer.html#getAdapter(java.lang.Class)"><code>IContainer.getAdapter(Class)</code></a> may still return |
| <code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the ContainerTypeDescription to report adapters for. Must not |
| be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String[] of supported adapters. The entries in the returned array |
| will be the fully qualified class names of adapters supported by |
| the given description. <code>null</code> may be returned by |
| the provider if no adapters are supported for this description.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSupportedParameterTypes(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedParameterTypes</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>[][]</span> <span class="memberName">getSupportedParameterTypes</span>​(<span class="arguments"><a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</span></div> |
| <div class="block">Get array of parameter types for given container type description. |
| Providers implement this method to allow clients to inspect the available |
| set of parameter types understood for calls to |
| <a href="#createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object%5B%5D)"><code>createInstance(ContainerTypeDescription, Object[])</code></a>. |
| <p> |
| Each of the rows of the returned array specifies a Class[] of parameter |
| types. These parameter types correspond to the types of Object[] that can |
| be passed into the second parameter of |
| <a href="#createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object%5B%5D)"><code>createInstance(ContainerTypeDescription, Object[])</code></a>. |
| <p> |
| Consider the following example: |
| <pre> |
| public Class[][] getSupportedParameterTypes() { |
| return new Class[][] { { String.class }, { String.class, String.class } }; |
| } |
| </pre> |
| |
| The above means that there are two acceptable values for the Object [] |
| passed into <a href="#createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object%5B%5D)"><code>createInstance(ContainerTypeDescription, Object[])</code></a>: |
| 1) a single String, and 2) two Strings. These would therefore be |
| acceptable as input to createInstance: |
| |
| <pre> |
| IContainer container = ContainerFactory.getDefault().createContainer( |
| description, new Object[] { "Hello" }); |
| |
| IContainer container2 = ContainerFactory.getDefault().createContainer( |
| description, new Object[] { "Hello" }); |
| </pre> |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the ContainerTypeDescription to return parameter types for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Class[][] array of Class[]s. Each row in the table corresponds to |
| a Class[] that describes the types of Objects in Object[] for |
| second parameter to |
| <a href="#createInstance(org.eclipse.ecf.core.ContainerTypeDescription,java.lang.Object%5B%5D)"><code>createInstance(ContainerTypeDescription, Object[])</code></a>. |
| <code>null</code> returned if no parameter types supported for |
| given description.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSupportedIntents(org.eclipse.ecf.core.ContainerTypeDescription)">getSupportedIntents</a></h3> |
| <div class="memberSignature"><span class="returnType"><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>[]</span> <span class="memberName">getSupportedIntents</span>​(<span class="arguments"><a href="../ContainerTypeDescription.html" title="class in org.eclipse.ecf.core">ContainerTypeDescription</a> description)</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/IContainerInstantiator.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>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> |
| </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> |