blob: 2783315dcc6419a7e8de8f35f9a6c7834bdeb5b8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>Time (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Time (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.utils</a></div>
<h2 title="Class Time" class="title">Class Time</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.storm.utils.Time</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">Time</span>
extends java.lang.Object</pre>
<div class="block">This class implements time simulation support. When time simulation is enabled,
methods on this class will use fixed time. When time simulation is disabled,
methods will pass through to relevant java.lang.System/java.lang.Thread calls.
Methods using units higher than nanoseconds will pass through to System.currentTimeMillis().
Methods supporting nanoseconds will pass through to System.nanoTime().</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Time.SimulatedTime.html" title="class in org.apache.storm.utils">Time.SimulatedTime</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#advanceTime(long)">advanceTime</a></span>&#8203;(long&nbsp;ms)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#advanceTimeNanos(long)">advanceTimeNanos</a></span>&#8203;(long&nbsp;nanos)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#advanceTimeSecs(long)">advanceTimeSecs</a></span>&#8203;(long&nbsp;secs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#currentTimeMillis()">currentTimeMillis</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#currentTimeSecs()">currentTimeSecs</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deltaMs(long)">deltaMs</a></span>&#8203;(long&nbsp;timeInMilliseconds)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deltaSecs(int)">deltaSecs</a></span>&#8203;(int&nbsp;timeInSeconds)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSimulating()">isSimulating</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isThreadWaiting(java.lang.Thread)">isThreadWaiting</a></span>&#8203;(java.lang.Thread&nbsp;t)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#millisToNanos(long)">millisToNanos</a></span>&#8203;(long&nbsp;millis)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nanosToMillis(long)">nanosToMillis</a></span>&#8203;(long&nbsp;nanos)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nanoTime()">nanoTime</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parkNanos(long)">parkNanos</a></span>&#8203;(long&nbsp;nanos)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secsToMillis(int)">secsToMillis</a></span>&#8203;(int&nbsp;secs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secsToMillisLong(double)">secsToMillisLong</a></span>&#8203;(double&nbsp;secs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sleep(long)">sleep</a></span>&#8203;(long&nbsp;ms)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sleepSecs(long)">sleepSecs</a></span>&#8203;(long&nbsp;secs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sleepUntil(long)">sleepUntil</a></span>&#8203;(long&nbsp;targetTimeMs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sleepUntilNanos(long)">sleepUntilNanos</a></span>&#8203;(long&nbsp;targetTimeNanos)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isSimulating()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSimulating</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isSimulating()</pre>
</li>
</ul>
<a id="sleepUntil(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sleepUntil</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sleepUntil&#8203;(long&nbsp;targetTimeMs)
throws java.lang.InterruptedException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="sleepUntilNanos(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sleepUntilNanos</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sleepUntilNanos&#8203;(long&nbsp;targetTimeNanos)
throws java.lang.InterruptedException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="sleep(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sleep</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sleep&#8203;(long&nbsp;ms)
throws java.lang.InterruptedException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="parkNanos(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parkNanos</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;parkNanos&#8203;(long&nbsp;nanos)
throws java.lang.InterruptedException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="sleepSecs(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sleepSecs</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sleepSecs&#8203;(long&nbsp;secs)
throws java.lang.InterruptedException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="nanoTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanoTime</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;nanoTime()</pre>
</li>
</ul>
<a id="currentTimeMillis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentTimeMillis</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;currentTimeMillis()</pre>
</li>
</ul>
<a id="nanosToMillis(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanosToMillis</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;nanosToMillis&#8203;(long&nbsp;nanos)</pre>
</li>
</ul>
<a id="millisToNanos(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>millisToNanos</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;millisToNanos&#8203;(long&nbsp;millis)</pre>
</li>
</ul>
<a id="secsToMillis(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>secsToMillis</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;secsToMillis&#8203;(int&nbsp;secs)</pre>
</li>
</ul>
<a id="secsToMillisLong(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>secsToMillisLong</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;secsToMillisLong&#8203;(double&nbsp;secs)</pre>
</li>
</ul>
<a id="currentTimeSecs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentTimeSecs</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;currentTimeSecs()</pre>
</li>
</ul>
<a id="deltaSecs(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deltaSecs</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;deltaSecs&#8203;(int&nbsp;timeInSeconds)</pre>
</li>
</ul>
<a id="deltaMs(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deltaMs</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;deltaMs&#8203;(long&nbsp;timeInMilliseconds)</pre>
</li>
</ul>
<a id="advanceTime(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advanceTime</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;advanceTime&#8203;(long&nbsp;ms)</pre>
</li>
</ul>
<a id="advanceTimeNanos(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advanceTimeNanos</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;advanceTimeNanos&#8203;(long&nbsp;nanos)</pre>
</li>
</ul>
<a id="advanceTimeSecs(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advanceTimeSecs</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;advanceTimeSecs&#8203;(long&nbsp;secs)</pre>
</li>
</ul>
<a id="isThreadWaiting(java.lang.Thread)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isThreadWaiting</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isThreadWaiting&#8203;(java.lang.Thread&nbsp;t)</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>