http://git-wip-us.apache.org/repos/asf/hbase-site/blob/7cf0bad8/apidocs/org/apache/hadoop/hbase/ScheduledChore.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/ScheduledChore.html
b/apidocs/org/apache/hadoop/hbase/ScheduledChore.html
index 2941d9e..c423d7e 100644
--- a/apidocs/org/apache/hadoop/hbase/ScheduledChore.html
+++ b/apidocs/org/apache/hadoop/hbase/ScheduledChore.html
@@ -2,24 +2,38 @@
<!-- NewPage -->
<html lang="en">
<head>
+<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ScheduledChore (Apache HBase 2.0.0-SNAPSHOT API)</title>
<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"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ScheduledChore (Apache HBase 2.0.0-SNAPSHOT
API)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ScheduledChore (Apache HBase 2.0.0-SNAPSHOT
API)";
+ }
+ }
+ catch(err) {
}
//-->
+var methods =
{"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a
name="navbar_top_firstrow">
+</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">
@@ -35,15 +49,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a
href="../../../../org/apache/hadoop/hbase/RetryImmediatelyException.html"
title="class in org.apache.hadoop.hbase"><span class="strong">Prev
Class</span></a></li>
-<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class
in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li>
+<li><a
href="../../../../org/apache/hadoop/hbase/RetryImmediatelyException.html"
title="class in org.apache.hadoop.hbase"><span
class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class
in org.apache.hadoop.hbase"><span
class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a
href="../../../../index.html?org/apache/hadoop/hbase/ScheduledChore.html"
target="_top">Frames</a></li>
-<li><a href="ScheduledChore.html" target="_top">No Frames</a></li>
+<li><a href="ScheduledChore.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>
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -62,17 +76,17 @@
<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>
+<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>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -83,7 +97,7 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
-<li><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
+<li><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.ScheduledChore</li>
@@ -95,18 +109,18 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
-<dd><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></dd>
+<dd><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
-@InterfaceStability.Stable
+ @InterfaceStability.Stable
public abstract class <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.46">ScheduledChore</a>
-extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a>
-implements <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></pre>
+extends <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a>
+implements <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></pre>
<div class="block">ScheduledChore is a task performed on a period in hbase.
ScheduledChores become active once
- scheduled with a <a
href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in
org.apache.hadoop.hbase"><code>ChoreService</code></a> via <a
href="../../../../org/apache/hadoop/hbase/ChoreService.html#scheduleChore(org.apache.hadoop.hbase.ScheduledChore)"><code>ChoreService.scheduleChore(ScheduledChore)</code></a>.
The
- chore is run in a <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html?is-external=true";
title="class or interface in
java.util.concurrent"><code>ScheduledThreadPoolExecutor</code></a> and competes
with other ScheduledChores for
+ scheduled with a <a
href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in
org.apache.hadoop.hbase"><code>ChoreService</code></a> via <a
href="../../../../org/apache/hadoop/hbase/ChoreService.html#scheduleChore-org.apache.hadoop.hbase.ScheduledChore-"><code>ChoreService.scheduleChore(ScheduledChore)</code></a>.
The
+ chore is run in a <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html?is-external=true";
title="class or interface in
java.util.concurrent"><code>ScheduledThreadPoolExecutor</code></a> and competes
with other ScheduledChores for
access to the threads in the core thread pool. If an unhandled exception
occurs, the chore
cancellation is logged. Implementers should consider whether or not the Chore
will be able to
execute within the defined period. It is bad practice to define a
ScheduledChore whose execution
@@ -123,11 +137,11 @@ implements <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_summary">
+<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">
+<table class="memberSummary" 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="colFirst" scope="col">Modifier</th>
@@ -135,115 +149,115 @@ implements <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore()">ScheduledChore</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore--">ScheduledChore</a></span>()</code>
<div class="block">This constructor is for test only.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int)">ScheduledChore</a></strong>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-">ScheduledChore</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int,%20long)">ScheduledChore</a></strong>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period,
- long initialDelay)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-">ScheduledChore</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period,
+ long initialDelay)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int,%20long,%20java.util.concurrent.TimeUnit)">ScheduledChore</a></strong>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period,
- long initialDelay,
- <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in
java.util.concurrent">TimeUnit</a> unit)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-java.util.concurrent.TimeUnit-">ScheduledChore</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period,
+ long initialDelay,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in
java.util.concurrent">TimeUnit</a> unit)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="method_summary">
+<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>
+<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"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a
href="javascript:show(4);">Abstract Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </span></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">
+<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel()">cancel</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel--">cancel</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel(boolean)">cancel</a></strong>(boolean mayInterruptIfRunning)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel-boolean-">cancel</a></span>(boolean mayInterruptIfRunning)</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#chore()">chore</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#chore--">chore</a></span>()</code>
<div class="block">The task to execute on each scheduled execution of the
Chore</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cleanup()">cleanup</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cleanup--">cleanup</a></span>()</code>
<div class="block">Override to run cleanup tasks when the Chore encounters an
error and must stop running</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getInitialDelay()">getInitialDelay</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getInitialDelay--">getInitialDelay</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getName()">getName</a></strong>()</code> </td>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getName--">getName</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getPeriod()">getPeriod</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getPeriod--">getPeriod</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code><a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a></code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getStopper()">getStopper</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getStopper--">getStopper</a></span>()</code> </td>
</tr>
-<tr class="altColor">
-<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in java.util.concurrent">TimeUnit</a></code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getTimeUnit()">getTimeUnit</a></strong>()</code> </td>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in java.util.concurrent">TimeUnit</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getTimeUnit--">getTimeUnit</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#initialChore()">initialChore</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#initialChore--">initialChore</a></span>()</code>
<div class="block">Override to run a task before we start looping.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isInitialChoreComplete()">isInitialChoreComplete</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isInitialChoreComplete--">isInitialChoreComplete</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isScheduled()">isScheduled</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isScheduled--">isScheduled</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#run()">run</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#run--">run</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#triggerNow()">triggerNow</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#triggerNow--">triggerNow</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
-<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
-<h3>Methods inherited from class java.lang.<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
-<code><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang
/Object.html?is-external=true#notifyAll()" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)"
title="class or interface in java.lang">wait</a></code></li>
+<h3>Methods inherited from class java.lang.<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
+<code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--";
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-";
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--";
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--";
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--";
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--";
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--";
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-";
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-";
title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -255,11 +269,11 @@ implements <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_detail">
+<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
-<a name="ScheduledChore()">
+<a name="ScheduledChore--">
<!-- -->
</a>
<ul class="blockList">
@@ -270,58 +284,76 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<div class="block">This constructor is for test only. It allows us to create
an object and to call chore() on it.</div>
</li>
</ul>
-<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable,
int)">
+<a
name="ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScheduledChore</h4>
-<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.136">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period)</pre>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> -
Name assigned to Chore. Useful for identification amongst chores of the same
type</dd><dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd><dd><code>period</code> -
Period in millis with which this Chore repeats execution when
scheduled.</dd></dl>
+<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.136">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - Name assigned to Chore. Useful for identification
amongst chores of the same type</dd>
+<dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped--"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd>
+<dd><code>period</code> - Period in millis with which this Chore repeats
execution when scheduled.</dd>
+</dl>
</li>
</ul>
-<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable,
int, long)">
+<a
name="ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScheduledChore</h4>
-<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.148">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period,
- long initialDelay)</pre>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> -
Name assigned to Chore. Useful for identification amongst chores of the same
type</dd><dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd><dd><code>period</code> -
Period in millis with which this Chore repeats execution when
scheduled.</dd><dd><code>initialDelay</code> - Delay before this Chore begins
to execute once it has been scheduled. A
+<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.148">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period,
+ long initialDelay)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - Name assigned to Chore. Useful for identification
amongst chores of the same type</dd>
+<dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped--"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd>
+<dd><code>period</code> - Period in millis with which this Chore repeats
execution when scheduled.</dd>
+<dd><code>initialDelay</code> - Delay before this Chore begins to execute once
it has been scheduled. A
value of 0 means the chore will begin to execute immediately.
Negative delays are
- invalid and will be corrected to a value of 0.</dd></dl>
+ invalid and will be corrected to a value of 0.</dd>
+</dl>
</li>
</ul>
-<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable,
int, long, java.util.concurrent.TimeUnit)">
+<a
name="ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScheduledChore</h4>
-<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.162">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
- <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper,
- int period,
- long initialDelay,
- <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in
java.util.concurrent">TimeUnit</a> unit)</pre>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> -
Name assigned to Chore. Useful for identification amongst chores of the same
type</dd><dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd><dd><code>period</code> -
Period in Timeunit unit with which this Chore repeats execution when
scheduled.</dd><dd><code>initialDelay</code> - Delay in Timeunit unit before
this Chore begins to execute once it has been
+<pre>public <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.162">ScheduledChore</a>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in
org.apache.hadoop.hbase">Stoppable</a> stopper,
+ int period,
+ long initialDelay,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in
java.util.concurrent">TimeUnit</a> unit)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - Name assigned to Chore. Useful for identification
amongst chores of the same type</dd>
+<dd><code>stopper</code> - When <a
href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped--"><code>Stoppable.isStopped()</code></a>
is true, this chore will cancel and cleanup</dd>
+<dd><code>period</code> - Period in Timeunit unit with which this Chore
repeats execution when scheduled.</dd>
+<dd><code>initialDelay</code> - Delay in Timeunit unit before this Chore
begins to execute once it has been
scheduled. A value of 0 means the chore will begin to execute
immediately. Negative
- delays are invalid and will be corrected to a value of
0.</dd><dd><code>unit</code> - The unit that is used to measure period and
initialDelay</dd></dl>
+ delays are invalid and will be corrected to a value of 0.</dd>
+<dd><code>unit</code> - The unit that is used to measure period and
initialDelay</dd>
+</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
-<li class="blockList"><a name="method_detail">
+<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="run()">
+<a name="run--">
<!-- -->
</a>
<ul class="blockList">
@@ -329,22 +361,27 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<h4>run</h4>
<pre>public void <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.175">run</a>()</pre>
<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true#run()"
title="class or interface in java.lang">run</a></code> in
interface <code><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></code></dd>
-<dt><span class="strong">See Also:</span></dt><dd><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true#run()"
title="class or interface in
java.lang"><code>Runnable.run()</code></a></dd></dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--";
title="class or interface in java.lang">run</a></code> in
interface <code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true";
title="class or interface in java.lang">Runnable</a></code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--";
title="class or interface in java.lang"><code>Runnable.run()</code></a></dd>
+</dl>
</li>
</ul>
-<a name="triggerNow()">
+<a name="triggerNow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>triggerNow</h4>
<pre>public boolean <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.254">triggerNow</a>()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>false when the Chore is
not currently scheduled with a ChoreService</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>false when the Chore is not currently scheduled with a ChoreService</dd>
+</dl>
</li>
</ul>
-<a name="cancel()">
+<a name="cancel--">
<!-- -->
</a>
<ul class="blockList">
@@ -353,7 +390,7 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<pre>public void <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.272">cancel</a>()</pre>
</li>
</ul>
-<a name="cancel(boolean)">
+<a name="cancel-boolean-">
<!-- -->
</a>
<ul class="blockList">
@@ -362,16 +399,16 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<pre>public void <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.276">cancel</a>(boolean mayInterruptIfRunning)</pre>
</li>
</ul>
-<a name="getName()">
+<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.282">getName</a>()</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.282">getName</a>()</pre>
</li>
</ul>
-<a name="getStopper()">
+<a name="getStopper--">
<!-- -->
</a>
<ul class="blockList">
@@ -380,36 +417,42 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<pre>public <a href="../../../../org/apache/hadoop/hbase/Stoppable.html"
title="interface in org.apache.hadoop.hbase">Stoppable</a> <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.286">getStopper</a>()</pre>
</li>
</ul>
-<a name="getPeriod()">
+<a name="getPeriod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeriod</h4>
<pre>public int <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.293">getPeriod</a>()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>period to execute chore
in getTimeUnit() units</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>period to execute chore in getTimeUnit() units</dd>
+</dl>
</li>
</ul>
-<a name="getInitialDelay()">
+<a name="getInitialDelay--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialDelay</h4>
<pre>public long <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.300">getInitialDelay</a>()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>initial delay before
executing chore in getTimeUnit() units</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>initial delay before executing chore in getTimeUnit() units</dd>
+</dl>
</li>
</ul>
-<a name="getTimeUnit()">
+<a name="getTimeUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeUnit</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in java.util.concurrent">TimeUnit</a> <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.304">getTimeUnit</a>()</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true";
title="class or interface in java.util.concurrent">TimeUnit</a> <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.304">getTimeUnit</a>()</pre>
</li>
</ul>
-<a name="isInitialChoreComplete()">
+<a name="isInitialChoreComplete--">
<!-- -->
</a>
<ul class="blockList">
@@ -418,17 +461,20 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<pre>public boolean <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.308">isInitialChoreComplete</a>()</pre>
</li>
</ul>
-<a name="isScheduled()">
+<a name="isScheduled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isScheduled</h4>
<pre>public boolean <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.330">isScheduled</a>()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true when this Chore is
scheduled with a ChoreService</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true when this Chore is scheduled with a ChoreService</dd>
+</dl>
</li>
</ul>
-<a name="chore()">
+<a name="chore--">
<!-- -->
</a>
<ul class="blockList">
@@ -438,7 +484,7 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<div class="block">The task to execute on each scheduled execution of the
Chore</div>
</li>
</ul>
-<a name="initialChore()">
+<a name="initialChore--">
<!-- -->
</a>
<ul class="blockList">
@@ -446,10 +492,13 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<h4>initialChore</h4>
<pre>protected boolean <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.349">initialChore</a>()</pre>
<div class="block">Override to run a task before we start looping.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true if initial chore was
successful</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if initial chore was successful</dd>
+</dl>
</li>
</ul>
-<a name="cleanup()">
+<a name="cleanup--">
<!-- -->
</a>
<ul class="blockListLast">
@@ -467,9 +516,11 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a
name="navbar_bottom_firstrow">
+</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">
@@ -485,15 +536,15 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
</div>
<div class="subNav">
<ul class="navList">
-<li><a
href="../../../../org/apache/hadoop/hbase/RetryImmediatelyException.html"
title="class in org.apache.hadoop.hbase"><span class="strong">Prev
Class</span></a></li>
-<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class
in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li>
+<li><a
href="../../../../org/apache/hadoop/hbase/RetryImmediatelyException.html"
title="class in org.apache.hadoop.hbase"><span
class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class
in org.apache.hadoop.hbase"><span
class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a
href="../../../../index.html?org/apache/hadoop/hbase/ScheduledChore.html"
target="_top">Frames</a></li>
-<li><a href="ScheduledChore.html" target="_top">No Frames</a></li>
+<li><a href="ScheduledChore.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>
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -512,17 +563,17 @@ protected <a
href="../../../../src-html/org/apache/hadoop/hbase/ScheduledCh
<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>
+<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>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
