blob: 2f56d3f0030a48d3bf0b724e5353ba7480f8e3d2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
<title>QueueEnqueueImpl (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.util, class: QueueEnqueueImpl">
<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":10,"i8":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/QueueEnqueueImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><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.util</a></div>
<h1 title="Class QueueEnqueueImpl" class="title">Class QueueEnqueueImpl</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.util.QueueEnqueueImpl</div>
</div>
<section class="description">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">QueueEnqueueImpl</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="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></pre>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== 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(org.eclipse.ecf.core.sharedobject.util.SimpleFIFOQueue)">QueueEnqueueImpl</a></span>&#8203;(<a href="SimpleFIFOQueue.html" title="class in org.eclipse.ecf.core.sharedobject.util">SimpleFIFOQueue</a>&nbsp;impl)</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enqueue(org.eclipse.ecf.core.util.Event)">enqueue</a></span>&#8203;(<a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>&nbsp;element)</code></th>
<td class="colLast">
<div class="block">Enqueue a given Event onto the underlying queue</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="#enqueue(org.eclipse.ecf.core.util.Event%5B%5D)">enqueue</a></span>&#8203;(<a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]&nbsp;elements)</code></th>
<td class="colLast">
<div class="block">Enqueue a set of events Event onto the underlying queue</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="#enqueue_abort(java.lang.Object)">enqueue_abort</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;enqueue_key)</code></th>
<td class="colLast">
<div class="block">Abort the commit of a set of Event instances previously prepared via
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></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="#enqueue_commit(java.lang.Object)">enqueue_commit</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;enqueue_key)</code></th>
<td class="colLast">
<div class="block">Commit a set of Event instances previously prepared via
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enqueue_lossy(org.eclipse.ecf.core.util.Event)">enqueue_lossy</a></span>&#8203;(<a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>&nbsp;element)</code></th>
<td class="colLast">
<div class="block">Enqueue the given event with lossy enqueuing.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)">enqueue_prepare</a></span>&#8203;(<a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]&nbsp;elements)</code></th>
<td class="colLast">
<div class="block">Prepare an enqueue of a set of Event instances.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="IEnqueueProcessor.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IEnqueueProcessor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnqueueProcessor()">getEnqueueProcessor</a></span>()</code></th>
<td class="colLast">
<div class="block">Get enqueue processor for this queue.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)">setEnqueueProcessor</a></span>&#8203;(<a href="IEnqueueProcessor.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IEnqueueProcessor</a>&nbsp;pred)</code></th>
<td class="colLast">
<div class="block">Set enqueue processor for this queue.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th>
<td class="colLast">
<div class="block">Return size of contents in queue</div>
</td>
</tr>
</tbody>
</table>
</div>
</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;(org.eclipse.ecf.core.sharedobject.util.SimpleFIFOQueue)">QueueEnqueueImpl</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">QueueEnqueueImpl</span>&#8203;(<span class="arguments"><a href="SimpleFIFOQueue.html" title="class in org.eclipse.ecf.core.sharedobject.util">SimpleFIFOQueue</a>&nbsp;impl)</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="enqueue(org.eclipse.ecf.core.util.Event)">enqueue</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">enqueue</span>&#8203;(<span class="arguments"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>&nbsp;element)</span>
throws <span class="exceptions"><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue(org.eclipse.ecf.core.util.Event)">IQueueEnqueue</a></code></span></div>
<div class="block">Enqueue a given Event onto the underlying queue</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue(org.eclipse.ecf.core.util.Event)">enqueue</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></code> - not thrown by this implementation.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enqueue(org.eclipse.ecf.core.util.Event[])">enqueue</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">enqueue</span>&#8203;(<span class="arguments"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]&nbsp;elements)</span>
throws <span class="exceptions"><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue(org.eclipse.ecf.core.util.Event%5B%5D)">IQueueEnqueue</a></code></span></div>
<div class="block">Enqueue a set of events Event onto the underlying queue</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue(org.eclipse.ecf.core.util.Event%5B%5D)">enqueue</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elements</code> - the Events to enqueue</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></code> - thrown if events cannot be enqueued</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enqueue_prepare(org.eclipse.ecf.core.util.Event[])">enqueue_prepare</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><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></span>&nbsp;<span class="memberName">enqueue_prepare</span>&#8203;(<span class="arguments"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]&nbsp;elements)</span>
throws <span class="exceptions"><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)">IQueueEnqueue</a></code></span></div>
<div class="block">Prepare an enqueue of a set of Event instances. The Object returned
should subsequently be used to either commit the prepared enqueue
transaction (<a href="IQueueEnqueue.html#enqueue_commit(java.lang.Object)"><code>IQueueEnqueue.enqueue_commit(Object)</code></a>, or to abort the prepared
enqueue transaction <a href="IQueueEnqueue.html#enqueue_abort(java.lang.Object)"><code>IQueueEnqueue.enqueue_abort(Object)</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)">enqueue_prepare</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elements</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="QueueException.html" title="class in org.eclipse.ecf.core.sharedobject.util">QueueException</a></code> - not thrown by this implementation.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enqueue_commit(java.lang.Object)">enqueue_commit</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">enqueue_commit</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;enqueue_key)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue_commit(java.lang.Object)">IQueueEnqueue</a></code></span></div>
<div class="block">Commit a set of Event instances previously prepared via
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue_commit(java.lang.Object)">enqueue_commit</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enqueue_key</code> - the transaction key previously returned from the call to
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enqueue_abort(java.lang.Object)">enqueue_abort</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">enqueue_abort</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;enqueue_key)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue_abort(java.lang.Object)">IQueueEnqueue</a></code></span></div>
<div class="block">Abort the commit of a set of Event instances previously prepared via
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue_abort(java.lang.Object)">enqueue_abort</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enqueue_key</code> - the transaction key previously returned from the call to
<a href="IQueueEnqueue.html#enqueue_prepare(org.eclipse.ecf.core.util.Event%5B%5D)"><code>IQueueEnqueue.enqueue_prepare(Event[])</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enqueue_lossy(org.eclipse.ecf.core.util.Event)">enqueue_lossy</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">enqueue_lossy</span>&#8203;(<span class="arguments"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>&nbsp;element)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#enqueue_lossy(org.eclipse.ecf.core.util.Event)">IQueueEnqueue</a></code></span></div>
<div class="block">Enqueue the given event with lossy enqueuing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#enqueue_lossy(org.eclipse.ecf.core.util.Event)">enqueue_lossy</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - the event to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if enqueued successfully, false if not</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)">setEnqueueProcessor</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setEnqueueProcessor</span>&#8203;(<span class="arguments"><a href="IEnqueueProcessor.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IEnqueueProcessor</a>&nbsp;pred)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)">IQueueEnqueue</a></code></span></div>
<div class="block">Set enqueue processor for this queue. The given processor, if non-null,
will be consulted when and enqueue operation is requested to determine
whether the enqueue should occur or not</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)">setEnqueueProcessor</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pred</code> - the IEnqueueProcessor for this queue. Should not be null.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getEnqueueProcessor()">getEnqueueProcessor</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="IEnqueueProcessor.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IEnqueueProcessor</a></span>&nbsp;<span class="memberName">getEnqueueProcessor</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#getEnqueueProcessor()">IQueueEnqueue</a></code></span></div>
<div class="block">Get enqueue processor for this queue. Returns the enqueue processor
previously assigned via the
<a href="IQueueEnqueue.html#setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)"><code>IQueueEnqueue.setEnqueueProcessor(IEnqueueProcessor)</code></a>. Returns null if no
enqueue processor previously assigned</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#getEnqueueProcessor()">getEnqueueProcessor</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IEnqueueProcessor previously assigned via
<a href="IQueueEnqueue.html#setEnqueueProcessor(org.eclipse.ecf.core.sharedobject.util.IEnqueueProcessor)"><code>IQueueEnqueue.setEnqueueProcessor(IEnqueueProcessor)</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="size()">size</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">size</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IQueueEnqueue.html#size()">IQueueEnqueue</a></code></span></div>
<div class="block">Return size of contents in queue</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IQueueEnqueue.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="IQueueEnqueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueueEnqueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int size of queue contents. Zero if empty</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/QueueEnqueueImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><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>