<!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>TimerTask (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="TimerTask (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/TimerTask.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="../../mx4j/timer/TimeQueue.html" title="class in mx4j.timer"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mx4j/timer/TimeTask.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/TimerTask.html" target="_top">Frames</a></li>
<li><a href="TimerTask.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 TimerTask" class="title">Class TimerTask</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">mx4j.timer.TimeTask</a></li>
<li>
<ul class="inheritance">
<li>mx4j.timer.TimerTask</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Comparable, java.lang.Runnable</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">TimerTask</span>
extends <a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></pre>
<div class="block">A subclass of TimeTask for the JMX Timer service.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.8 $</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/TimerTask.html#TimerTask(javax.management.timer.TimerNotification, java.util.Date, long, long, boolean)">TimerTask</a></strong>(javax.management.timer.TimerNotification n,
java.util.Date date,
long period,
long occurrences,
boolean fixedRate)</code> </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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getDate()">getDate</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getFixedRate()">getFixedRate</a></strong>()</code>
<div class="block">Returns whether this task is a fixed rate or fixed delay task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getNextExecutionTime()">getNextExecutionTime</a></strong>()</code>
<div class="block">Returns the next time at which the task will be executed, ie the <a href="../../mx4j/timer/TimeTask.html#run()"><code>TimeTask.run()</code></a> method is called.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.management.timer.TimerNotification</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getNotification()">getNotification</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getOccurrences()">getOccurrences</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#getPeriod()">getPeriod</a></strong>()</code>
<div class="block">Returns the period of this task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#isFinished()">isFinished</a></strong>()</code>
<div class="block">Returns whethere this task is finished.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#isPeriodic()">isPeriodic</a></strong>()</code>
<div class="block">Returns whether this task is periodic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#setFinished(boolean)">setFinished</a></strong>(boolean value)</code>
<div class="block">Marks this task as finished or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/timer/TimerTask.html#setNextExecutionTime(long)">setNextExecutionTime</a></strong>(long time)</code>
<div class="block">Sets the next execution time.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_mx4j.timer.TimeTask">
<!-- -->
</a>
<h3>Methods inherited from class mx4j.timer.<a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></h3>
<code><a href="../../mx4j/timer/TimeTask.html#compareTo(java.lang.Object)">compareTo</a>, <a href="../../mx4j/timer/TimeTask.html#run()">run</a></code></li>
</ul>
<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, finalize, getClass, 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="TimerTask(javax.management.timer.TimerNotification, java.util.Date, long, long, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimerTask</h4>
<pre>public TimerTask(javax.management.timer.TimerNotification n,
java.util.Date date,
long period,
long occurrences,
boolean fixedRate)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNotification()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNotification</h4>
<pre>public javax.management.timer.TimerNotification getNotification()</pre>
</li>
</ul>
<a name="isFinished()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFinished</h4>
<pre>public boolean isFinished()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#isFinished()">TimeTask</a></code></strong></div>
<div class="block">Returns whethere this task is finished.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#isFinished()">isFinished</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#setFinished(boolean)"><code>TimeTask.setFinished(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setFinished(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFinished</h4>
<pre>public void setFinished(boolean value)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#setFinished(boolean)">TimeTask</a></code></strong></div>
<div class="block">Marks this task as finished or not. When a task is finished, its
<a href="../../mx4j/timer/TimeTask.html#run()"><code>TimeTask.run()</code></a> method will not be called anymore.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#setFinished(boolean)">setFinished</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#isFinished()"><code>TimeTask.isFinished()</code></a></dd></dl>
</li>
</ul>
<a name="getPeriod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeriod</h4>
<pre>public long getPeriod()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#getPeriod()">TimeTask</a></code></strong></div>
<div class="block">Returns the period of this task. By default returns 0.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#getPeriod()">getPeriod</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#isPeriodic()"><code>TimeTask.isPeriodic()</code></a></dd></dl>
</li>
</ul>
<a name="isPeriodic()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPeriodic</h4>
<pre>public boolean isPeriodic()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#isPeriodic()">TimeTask</a></code></strong></div>
<div class="block">Returns whether this task is periodic. By default return false.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#isPeriodic()">isPeriodic</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#getPeriod()"><code>TimeTask.getPeriod()</code></a></dd></dl>
</li>
</ul>
<a name="getNextExecutionTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextExecutionTime</h4>
<pre>public long getNextExecutionTime()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#getNextExecutionTime()">TimeTask</a></code></strong></div>
<div class="block">Returns the next time at which the task will be executed, ie the <a href="../../mx4j/timer/TimeTask.html#run()"><code>TimeTask.run()</code></a> method is called.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#getNextExecutionTime()">getNextExecutionTime</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#setNextExecutionTime(long)"><code>TimeTask.setNextExecutionTime(long)</code></a></dd></dl>
</li>
</ul>
<a name="setNextExecutionTime(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextExecutionTime</h4>
<pre>public void setNextExecutionTime(long time)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#setNextExecutionTime(long)">TimeTask</a></code></strong></div>
<div class="block">Sets the next execution time.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#setNextExecutionTime(long)">setNextExecutionTime</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/timer/TimeTask.html#getNextExecutionTime()"><code>TimeTask.getNextExecutionTime()</code></a></dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getOccurrences()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOccurrences</h4>
<pre>public long getOccurrences()</pre>
</li>
</ul>
<a name="getDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDate</h4>
<pre>public long getDate()</pre>
</li>
</ul>
<a name="getFixedRate()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFixedRate</h4>
<pre>public boolean getFixedRate()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../mx4j/timer/TimeTask.html#getFixedRate()">TimeTask</a></code></strong></div>
<div class="block">Returns whether this task is a fixed rate or fixed delay task. By default
return false</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../mx4j/timer/TimeTask.html#getFixedRate()">getFixedRate</a></code> in class <code><a href="../../mx4j/timer/TimeTask.html" title="class in mx4j.timer">TimeTask</a></code></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><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/TimerTask.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="../../mx4j/timer/TimeQueue.html" title="class in mx4j.timer"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mx4j/timer/TimeTask.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/TimerTask.html" target="_top">Frames</a></li>
<li><a href="TimerTask.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>
