blob: ecaae0d621cc91288178b9d6fe233e6a26798e8b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EventManager (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EventManager (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":18,"i2":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EventManager.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-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventInterceptor.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/util/scheduling/EventManager.html" target="_top">Frames</a></li>
<li><a href="EventManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.mosaic.lib.util.scheduling</div>
<h2 title="Interface EventManager" class="title">Interface EventManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventScheduler.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventScheduler</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/eclipse/mosaic/fed/application/ambassador/ApplicationAmbassador.html" title="class in org.eclipse.mosaic.fed.application.ambassador">ApplicationAmbassador</a>, <a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html" title="class in org.eclipse.mosaic.fed.cell.chain">ChainManager</a>, <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/DefaultEventScheduler.html" title="class in org.eclipse.mosaic.lib.util.scheduling">DefaultEventScheduler</a>, <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventInterceptor.html" title="class in org.eclipse.mosaic.lib.util.scheduling">EventInterceptor</a>, <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/MultiThreadedEventScheduler.html" title="class in org.eclipse.mosaic.lib.util.scheduling">MultiThreadedEventScheduler</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EventManager</span></pre>
<div class="block">The event manager stores events and forces further steps that are required to
process the event.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">addEvent</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a>&nbsp;event)</code>
<div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#addEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">addEvent</a></span>(long&nbsp;time,
<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a>...&nbsp;eventProcessors)</code>
<div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html" title="class in org.eclipse.mosaic.lib.util.scheduling">EventBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#newEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">newEvent</a></span>(long&nbsp;time,
<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a>...&nbsp;eventProcessor)</code>
<div class="block">Creates a new <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>EventBuilder</code></a> object which must be used to
setup an event.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEvent</h4>
<pre>void&nbsp;addEvent(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a>&nbsp;event)</pre>
<div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the event to schedule.</dd>
</dl>
</li>
</ul>
<a name="addEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEvent</h4>
<pre>default&nbsp;void&nbsp;addEvent(long&nbsp;time,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a>...&nbsp;eventProcessors)</pre>
<div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>time</code> - the time to schedule the event</dd>
<dd><code>eventProcessors</code> - the processors to process the event when scheduled</dd>
</dl>
</li>
</ul>
<a name="newEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newEvent</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html" title="class in org.eclipse.mosaic.lib.util.scheduling">EventBuilder</a>&nbsp;newEvent(long&nbsp;time,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a>...&nbsp;eventProcessor)</pre>
<div class="block">Creates a new <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>EventBuilder</code></a> object which must be used to
setup an event. Eventually, the <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html#schedule--"><code>EventBuilder.schedule()</code></a> method must
be called to add the event to this <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><code>EventManager</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>time</code> - the time the new event should be scheduled</dd>
<dd><code>eventProcessor</code> - the processor to process the event when scheduled</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventBuilder.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>EventBuilder</code></a> instance to create the <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EventManager.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-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventInterceptor.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/util/scheduling/EventManager.html" target="_top">Frames</a></li>
<li><a href="EventManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>