<!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 (version 1.7.0_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>TimeQueue (MX4J API)</title>
<meta name="date" content="2013-10-18">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TimeQueue (MX4J API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/TimeQueue.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>Prev Class</li>
<li><a href="../../mx4j/timer/TimerTask.html" title="class in mx4j.timer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mx4j/timer/TimeQueue.html" target="_top">Frames</a></li>
<li><a href="TimeQueue.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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">mx4j.timer</div>
<h2 title="Class TimeQueue" class="title">Class TimeQueue</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>mx4j.timer.TimeQueue</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">TimeQueue</span>
extends java.lang.Object</pre>
<div class="block">A queue that executes <a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer"><code>TimeTask</code></a>s when it is started. <br>
Every scheduled task is executed at the specified time; if this time is in the past,
the task is executed immediately.
Just before the task is executed, the task itself is updated so that its new
execution time is set or it is marked as finished (if it is not forever periodic).</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.5 $</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer"><code>TimeTask</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mx4j/timer/TimeQueue.html#TimeQueue()">TimeQueue</a></strong>()</code>
<div class="block">Creates a new TimeQueue</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../mx4j/timer/TimeQueue.html#TimeQueue(boolean)">TimeQueue</a></strong>(boolean daemon)</code>
<div class="block">Creates a new TimeQueue that will set the thread daemon or not depending on the given argument</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#clear()">clear</a></strong>()</code>
<div class="block">Removes all the tasks from this TimeQueue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#schedule(mx4j.timer.TimeTask)">schedule</a></strong>(<a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a> task)</code>
<div class="block">Schedules the given task for execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#size()">size</a></strong>()</code>
<div class="block">Returns the number of tasks present in this TimeQueue</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#start()">start</a></strong>()</code>
<div class="block">Starts this TimeQueue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#stop()">stop</a></strong>()</code>
<div class="block">Stops this TimeQueue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimeQueue.html#unschedule(mx4j.timer.TimeTask)">unschedule</a></strong>(<a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a> task)</code>
<div class="block">Removes the given task from this TimeQueue</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TimeQueue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TimeQueue</h4>
<pre>public TimeQueue()</pre>
<div class="block">Creates a new TimeQueue</div>
</li>
</ul>
<a name="TimeQueue(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimeQueue</h4>
<pre>public TimeQueue(boolean daemon)</pre>
<div class="block">Creates a new TimeQueue that will set the thread daemon or not depending on the given argument</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public void start()</pre>
<div class="block">Starts this TimeQueue. <br>
Tasks are executed only after the queue has been started.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeQueue.html#stop()"><code>stop()</code></a></dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public void stop()</pre>
<div class="block">Stops this TimeQueue. <br>
No task is executed when the queue is stopped; however, already scheduled tasks
are not removed; restarting the queue has the effect of executing the tasks remained
if their time has come.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeQueue.html#start()"><code>start()</code></a></dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Returns the number of tasks present in this TimeQueue</div>
</li>
</ul>
<a name="schedule(mx4j.timer.TimeTask)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schedule</h4>
<pre>public void schedule(<a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a> task)</pre>
<div class="block">Schedules the given task for execution.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeQueue.html#unschedule(mx4j.timer.TimeTask)"><code>unschedule(mx4j.timer.TimeTask)</code></a></dd></dl>
</li>
</ul>
<a name="unschedule(mx4j.timer.TimeTask)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unschedule</h4>
<pre>public void unschedule(<a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a> task)</pre>
<div class="block">Removes the given task from this TimeQueue</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeQueue.html#schedule(mx4j.timer.TimeTask)"><code>schedule(mx4j.timer.TimeTask)</code></a></dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Removes all the tasks from this TimeQueue.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/TimeQueue.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>Prev Class</li>
<li><a href="../../mx4j/timer/TimerTask.html" title="class in mx4j.timer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mx4j/timer/TimeQueue.html" target="_top">Frames</a></li>
<li><a href="TimeQueue.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
