blob: 2606c94e48bb4dce4a2d442d67652d782be4175b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>OptimisticSharedObject (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: OptimisticSharedObject">
<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};
var tabs = {65535:["t0","All 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/OptimisticSharedObject.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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="Class OptimisticSharedObject" class="title">Class OptimisticSharedObject</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"><a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">org.eclipse.ecf.core.sharedobject.BaseSharedObject</a>
<div class="inheritance">org.eclipse.ecf.core.sharedobject.OptimisticSharedObject</div>
</div>
</div>
<section class="description">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code>, <code><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="model/SharedModel.html" title="class in org.eclipse.ecf.core.sharedobject.model">SharedModel</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">OptimisticSharedObject</span>
extends <a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></pre>
<div class="block">Superclass for shared object classes that replicate themselves
optimistically. May be subclassed as desired.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject"><code>BaseSharedObject</code></a></dd>
</dl>
</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="inheritedList">
<h3>Fields inherited from class&nbsp;org.eclipse.ecf.core.sharedobject.<a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></h3>
<a id="fields.inherited.from.class.org.eclipse.ecf.core.sharedobject.BaseSharedObject">
<!-- -->
</a><code><a href="BaseSharedObject.html#DESTROYREMOTE_CODE">DESTROYREMOTE_CODE</a>, <a href="BaseSharedObject.html#DESTROYSELFLOCAL_CODE">DESTROYSELFLOCAL_CODE</a></code></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">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">OptimisticSharedObject</a></span>()</code></th>
<td class="colLast">&nbsp;</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="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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th>
<td class="colLast">
<div class="block">Initialize this shared object.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;org.eclipse.ecf.core.sharedobject.<a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.core.sharedobject.BaseSharedObject">
<!-- -->
</a><code><a href="BaseSharedObject.html#addEventProcessor(org.eclipse.ecf.core.util.IEventProcessor)">addEventProcessor</a>, <a href="BaseSharedObject.html#clearEventProcessors()">clearEventProcessors</a>, <a href="BaseSharedObject.html#creationCompleted()">creationCompleted</a>, <a href="BaseSharedObject.html#destroyRemote(org.eclipse.ecf.core.identity.ID)">destroyRemote</a>, <a href="BaseSharedObject.html#destroySelf()">destroySelf</a>, <a href="BaseSharedObject.html#destroySelfLocal()">destroySelfLocal</a>, <a href="BaseSharedObject.html#dispose(org.eclipse.ecf.core.identity.ID)">dispose</a>, <a href="BaseSharedObject.html#fireEventProcessors(org.eclipse.ecf.core.util.Event)">fireEventProcessors</a>, <a href="BaseSharedObject.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="BaseSharedObject.html#getConfig()">getConfig</a>, <a href="BaseSharedObject.html#getConnectedID()">getConnectedID</a>, <a href="BaseSharedObject.html#getContext()">getContext</a>, <a href="BaseSharedObject.html#getGroupMemberIDs()">getGroupMemberIDs</a>, <a href="BaseSharedObject.html#getHomeContainerID()">getHomeContainerID</a>, <a href="BaseSharedObject.html#getID()">getID</a>, <a href="BaseSharedObject.html#getLocalContainerID()">getLocalContainerID</a>, <a href="BaseSharedObject.html#getProperties()">getProperties</a>, <a href="BaseSharedObject.html#getReplicaDescription(org.eclipse.ecf.core.identity.ID)">getReplicaDescription</a>, <a href="BaseSharedObject.html#getReplicaDescriptions(org.eclipse.ecf.core.identity.ID%5B%5D)">getReplicaDescriptions</a>, <a href="BaseSharedObject.html#getSharedObjectMsgFromEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">getSharedObjectMsgFromEvent</a>, <a href="BaseSharedObject.html#handleEvent(org.eclipse.ecf.core.util.Event)">handleEvent</a>, <a href="BaseSharedObject.html#handleEvents(org.eclipse.ecf.core.util.Event%5B%5D)">handleEvents</a>, <a href="BaseSharedObject.html#handleSharedObjectCreateResponseEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectCreateResponseEvent)">handleSharedObjectCreateResponseEvent</a>, <a href="BaseSharedObject.html#handleSharedObjectMsg(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a>, <a href="BaseSharedObject.html#handleSharedObjectMsg(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a>, <a href="BaseSharedObject.html#handleSharedObjectMsgEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">handleSharedObjectMsgEvent</a>, <a href="BaseSharedObject.html#handleUnhandledEvent(org.eclipse.ecf.core.util.Event)">handleUnhandledEvent</a>, <a href="BaseSharedObject.html#init(org.eclipse.ecf.core.sharedobject.ISharedObjectConfig)">init</a>, <a href="BaseSharedObject.html#isConnected()">isConnected</a>, <a href="BaseSharedObject.html#isPrimary()">isPrimary</a>, <a href="BaseSharedObject.html#log(int,java.lang.String,java.lang.Throwable)">log</a>, <a href="BaseSharedObject.html#log(java.lang.String,java.lang.Throwable)">log</a>, <a href="BaseSharedObject.html#removeEventProcessor(org.eclipse.ecf.core.util.IEventProcessor)">removeEventProcessor</a>, <a href="BaseSharedObject.html#replicateToRemoteContainers(org.eclipse.ecf.core.identity.ID%5B%5D)">replicateToRemoteContainers</a>, <a href="BaseSharedObject.html#sendSharedObjectMsgTo(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgTo</a>, <a href="BaseSharedObject.html#sendSharedObjectMsgToPrimary(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgToPrimary</a>, <a href="BaseSharedObject.html#sendSharedObjectMsgToSelf(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgToSelf</a>, <a href="BaseSharedObject.html#trace(java.lang.String,java.lang.String)">trace</a>, <a href="BaseSharedObject.html#traceCatching(java.lang.String,java.lang.Throwable)">traceCatching</a>, <a href="BaseSharedObject.html#traceEntering(java.lang.String)">traceEntering</a>, <a href="BaseSharedObject.html#traceEntering(java.lang.String,java.lang.Object)">traceEntering</a>, <a href="BaseSharedObject.html#traceEntering(java.lang.String,java.lang.Object%5B%5D)">traceEntering</a>, <a href="BaseSharedObject.html#traceExiting(java.lang.String)">traceExiting</a>, <a href="BaseSharedObject.html#traceExiting(java.lang.String,java.lang.Object)">traceExiting</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;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">
<!-- ========= 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="&lt;init&gt;()">OptimisticSharedObject</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">OptimisticSharedObject</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="initialize()">initialize</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">initialize</span>()
throws <span class="exceptions"><a href="SharedObjectInitException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectInitException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="BaseSharedObject.html#initialize()">BaseSharedObject</a></code></span></div>
<div class="block">Initialize this shared object. Subclasses may override as appropriate to
define custom initialization behavior. If initialization should fail,
then a SharedObjectInitException should be thrown by implementing code.
Also, subclasses overriding this method should call super.initialize()
before running their own code.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="BaseSharedObject.html#initialize()">initialize</a></code>&nbsp;in class&nbsp;<code><a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></code></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> - if initialization should throw</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/OptimisticSharedObject.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>