testdevapidocs/org/apache/hadoop/hbase/Waiter.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Waiter (Apache HBase 4.0.0-alpha-1-SNAPSHOT Test API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.hadoop.hbase, class: Waiter">
 <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.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="../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/Waiter.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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&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="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase</a></div>
 <h1 title="Class Waiter" class="title">Class Waiter</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.hadoop.hbase.Waiter</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="annotations">@Private
 </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-33">Waiter</a></span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">A class that provides a standard waitFor pattern See details at
  https://issues.apache.org/jira/browse/HBASE-7384</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="Waiter.ExplainingPredicate.html" class="type-name-link" title="interface in org.apache.hadoop.hbase">Waiter.ExplainingPredicate</a>&lt;<a href="Waiter.ExplainingPredicate.html" title="type parameter in Waiter.ExplainingPredicate">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;</code></div>
 <div class="col-last even-row-color">
 <div class="block">A mixin interface, can be used with <a href="Waiter.html" title="class in org.apache.hadoop.hbase"><code>Waiter</code></a> to explain failed state.</div>
 </div>
 <div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="Waiter.Predicate.html" class="type-name-link" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;<a href="Waiter.Predicate.html" title="type parameter in Waiter.Predicate">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;</code></div>
 <div class="col-last odd-row-color">
 <div class="block">A predicate 'closure' used by the <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a> and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a> and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color"><code><a href="#HBASE_TEST_WAIT_FOR_RATIO" class="member-name-link">HBASE_TEST_WAIT_FOR_RATIO</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">System property name whose value is a scale factor to increase time out values dynamically used
  in <a href="#sleep(org.apache.hadoop.conf.Configuration,long)"><code>sleep(Configuration, long)</code></a>, <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, Predicate)</code></a>, and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> method</div>
 </div>
 <div class="col-first odd-row-color"><code>private static float</code></div>
 <div class="col-second odd-row-color"><code><a href="#HBASE_WAIT_FOR_RATIO_DEFAULT" class="member-name-link">HBASE_WAIT_FOR_RATIO_DEFAULT</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div>
 <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private static float</code></div>
 <div class="col-second odd-row-color"><code><a href="#waitForRatio" class="member-name-link">waitForRatio</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier</div>
 <div class="table-header col-second">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>private </code></div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Waiter</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getExplanation(org.apache.hadoop.hbase.Waiter.Predicate)" class="member-name-link">getExplanation</a><wbr>(<a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;?&gt;&nbsp;explain)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)" class="member-name-link">getWaitForRatio</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the 'wait for ratio' used in the <a href="#sleep(org.apache.hadoop.conf.Configuration,long)"><code>sleep(Configuration, long)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, Predicate)</code></a> and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods of the class</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sleep(org.apache.hadoop.conf.Configuration,long)" class="member-name-link">sleep</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;time)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Makes the current thread sleep for the duration equal to the specified time in milliseconds
  multiplied by the <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;<br>long</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)" class="member-name-link">waitFor</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  long&nbsp;interval,
  boolean&nbsp;failIfTimeout,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached, the Predicate is still
  <code>false</code> and failIfTimeout is set as <code>true</code>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;<br>long</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)" class="member-name-link">waitFor</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  long&nbsp;interval,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached and the Predicate is still
  <code>false</code>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;<br>long</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)" class="member-name-link">waitFor</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached and the Predicate is still
  <code>false</code>.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="LOG">
 <h3>LOG</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-35">LOG</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="HBASE_TEST_WAIT_FOR_RATIO">
 <h3>HBASE_TEST_WAIT_FOR_RATIO</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-45">HBASE_TEST_WAIT_FOR_RATIO</a></span></div>
 <div class="block">System property name whose value is a scale factor to increase time out values dynamically used
  in <a href="#sleep(org.apache.hadoop.conf.Configuration,long)"><code>sleep(Configuration, long)</code></a>, <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, Predicate)</code></a>, and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> method
  <p/>
  The actual time out value will equal to hbase.test.wait.for.ratio * passed-in timeout</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Waiter.HBASE_TEST_WAIT_FOR_RATIO">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="HBASE_WAIT_FOR_RATIO_DEFAULT">
 <h3>HBASE_WAIT_FOR_RATIO_DEFAULT</h3>
 <div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-47">HBASE_WAIT_FOR_RATIO_DEFAULT</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="waitForRatio">
 <h3>waitForRatio</h3>
 <div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-49">waitForRatio</a></span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>Waiter</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-51">Waiter</a></span>()</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getWaitForRatio(org.apache.hadoop.conf.Configuration)">
 <h3>getWaitForRatio</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-68">getWaitForRatio</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf)</span></div>
 <div class="block">Returns the 'wait for ratio' used in the <a href="#sleep(org.apache.hadoop.conf.Configuration,long)"><code>sleep(Configuration, long)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, Predicate)</code></a>,
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, Predicate)</code></a> and
  <a href="#waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods of the class
  <p/>
  This is useful to dynamically adjust max time out values when same test cases run in different
  test machine settings without recompiling &amp; re-deploying code.
  <p/>
  The value is obtained from the Java System property or configuration setting
  <code>hbase.test.wait.for.ratio</code> which defaults to <code>1</code>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - the configuration</dd>
 <dt>Returns:</dt>
 <dd>the 'wait for ratio' for the current test run.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="sleep(org.apache.hadoop.conf.Configuration,long)">
 <h3>sleep</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-113">sleep</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;time)</span></div>
 <div class="block">Makes the current thread sleep for the duration equal to the specified time in milliseconds
  multiplied by the <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - the configuration</dd>
 <dd><code>time</code> - the number of milliseconds to sleep.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="waitFor(org.apache.hadoop.conf.Configuration,long,org.apache.hadoop.hbase.Waiter.Predicate)">
 <h3>waitFor</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-133">waitFor</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</span></div>
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached and the Predicate is still
  <code>false</code>.
  <p/></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - the configuration</dd>
 <dd><code>timeout</code> - the timeout in milliseconds to wait for the predicate.</dd>
 <dd><code>predicate</code> - the predicate to evaluate.</dd>
 <dt>Returns:</dt>
 <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or
          wait is interrupted otherwise <code>-1</code> when times out</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="waitFor(org.apache.hadoop.conf.Configuration,long,long,org.apache.hadoop.hbase.Waiter.Predicate)">
 <h3>waitFor</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-151">waitFor</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  long&nbsp;interval,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</span></div>
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached and the Predicate is still
  <code>false</code>.
  <p/></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - the configuration</dd>
 <dd><code>timeout</code> - the max timeout in milliseconds to wait for the predicate.</dd>
 <dd><code>interval</code> - the interval in milliseconds to evaluate predicate.</dd>
 <dd><code>predicate</code> - the predicate to evaluate.</dd>
 <dt>Returns:</dt>
 <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or
          wait is interrupted otherwise <code>-1</code> when times out</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="waitFor(org.apache.hadoop.conf.Configuration,long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)">
 <h3>waitFor</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;E extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&gt;</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-170">waitFor</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
  long&nbsp;timeout,
  long&nbsp;interval,
  boolean&nbsp;failIfTimeout,
  <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;E&gt;&nbsp;predicate)</span></div>
 <div class="block">Waits up to the duration equal to the specified timeout multiplied by the
  <a href="#getWaitForRatio(org.apache.hadoop.conf.Configuration)"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become
  <code>true</code>, failing the test if the timeout is reached, the Predicate is still
  <code>false</code> and failIfTimeout is set as <code>true</code>.
  <p/></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - the configuration</dd>
 <dd><code>timeout</code> - the timeout in milliseconds to wait for the predicate.</dd>
 <dd><code>interval</code> - the interval in milliseconds to evaluate predicate.</dd>
 <dd><code>failIfTimeout</code> - indicates if should fail current test case when times out.</dd>
 <dd><code>predicate</code> - the predicate to evaluate.</dd>
 <dt>Returns:</dt>
 <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or
          wait is interrupted otherwise <code>-1</code> when times out</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getExplanation(org.apache.hadoop.hbase.Waiter.Predicate)">
 <h3>getExplanation</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line-216">getExplanation</a></span><wbr><span class="parameters">(<a href="Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a>&lt;?&gt;&nbsp;explain)</span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>