| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>ISharedObject (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: ISharedObject"> |
| <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/ISharedObject.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.sharedobject</a></div> |
| <h1 title="Interface ISharedObject" class="title">Interface ISharedObject</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></code>, <code><a href="../../remoteservice/eventadmin/DistributedEventAdmin.html" title="class in org.eclipse.ecf.remoteservice.eventadmin">DistributedEventAdmin</a></code>, <code><a href="OptimisticSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">OptimisticSharedObject</a></code>, <code><a href="../../provider/remoteservice/generic/RegistrySharedObject.html" title="class in org.eclipse.ecf.provider.remoteservice.generic">RegistrySharedObject</a></code>, <code><a href="model/SharedModel.html" title="class in org.eclipse.ecf.core.sharedobject.model">SharedModel</a></code>, <code><a href="TransactionSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">TransactionSharedObject</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ISharedObject</span> |
| extends org.eclipse.core.runtime.IAdaptable</pre> |
| <div class="block">Core interface for implementing components that exist within |
| <a href="ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObjectContainer</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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dispose(org.eclipse.ecf.core.identity.ID)">dispose</a></span>​(<a href="../identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called by the ISharedObjectContainer upon ISharedObject |
| destruction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleEvent(org.eclipse.ecf.core.util.Event)">handleEvent</a></span>​(<a href="../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a> event)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle Event passed to this IEventHandler.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleEvents(org.eclipse.ecf.core.util.Event%5B%5D)">handleEvents</a></span>​(<a href="../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[] events)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle Events passed to this IEventHandler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.eclipse.ecf.core.sharedobject.ISharedObjectConfig)">init</a></span>​(<a href="ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectConfig</a> initData)</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize this ISharedObject.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.core.runtime.IAdaptable</h3> |
| <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable"> |
| <!-- --> |
| </a><code>getAdapter</code></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="init(org.eclipse.ecf.core.sharedobject.ISharedObjectConfig)">init</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">init</span>​(<span class="arguments"><a href="ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectConfig</a> initData)</span> |
| throws <span class="exceptions"><a href="SharedObjectInitException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectInitException</a></span></div> |
| <div class="block">Initialize this ISharedObject. The ISharedObjectContainer for this |
| ISharedObject must call this method with a non-null instance of |
| ISharedObjectConfig. ISharedObject implementations can use this |
| initialization to perform any initialization necessary prior to receiving |
| any events (via handleEvent/s). Note that the ISharedObjectContext |
| provided via the ISharedObjectConfig.getSharedObjectContext() method is |
| not guaranteed to allow any method calls until after this init() method |
| call has completed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initData</code> - the initialization data passed by the ISharedObjectContainer |
| upon initialization</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="SharedObjectInitException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectInitException</a></code> - thrown by ISharedObject to halt initialization. |
| ISharedObjectContainers must respond to such an exception |
| by halting the addition of the ISharedObject instance and |
| treating it as <b>not </b> in the container.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleEvent(org.eclipse.ecf.core.util.Event)">handleEvent</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">handleEvent</span>​(<span class="arguments"><a href="../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a> event)</span></div> |
| <div class="block">Handle Event passed to this IEventHandler.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the Event for the implementer to handle</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleEvents(org.eclipse.ecf.core.util.Event[])">handleEvents</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">handleEvents</span>​(<span class="arguments"><a href="../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[] events)</span></div> |
| <div class="block">Handle Events passed to this IEventHandler.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>events</code> - the Events [] for the implementer to handle</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dispose(org.eclipse.ecf.core.identity.ID)">dispose</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">dispose</span>​(<span class="arguments"><a href="../identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID)</span></div> |
| <div class="block">Method called by the ISharedObjectContainer upon ISharedObject |
| destruction. Once this method is called, no more Events will be passed to |
| a ISharedObject until the init method is called again.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerID</code> - the ID of the container that is disposing this ISharedObject</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/ISharedObject.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> |