http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f58e71c6/devapidocs/org/apache/hadoop/hbase/ProcedureUtil.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ProcedureUtil.html b/devapidocs/org/apache/hadoop/hbase/ProcedureUtil.html new file mode 100644 index 0000000..404f400 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/ProcedureUtil.html @@ -0,0 +1,313 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ProcedureUtil (Apache HBase 2.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProcedureUtil (Apache HBase 2.0.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProcedureUtil.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.ForeignExceptionMsg.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ProcedureUtil.html" target="_top">Frames</a></li> +<li><a href="ProcedureUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase</div> +<h2 title="Class ProcedureUtil" class="title">Class ProcedureUtil</h2> +</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> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ProcedureUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public class <a href="../../../../src-html/org/apache/hadoop/hbase/ProcedureUtil.html#line.31">ProcedureUtil</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></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.ForeignExceptionMsg.html" title="class in org.apache.hadoop.hbase">ProcedureUtil.ForeignExceptionMsg</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.html#ProcedureUtil()">ProcedureUtil</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase">ProcedureInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.html#convert(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure)">convert</a></strong>(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure procProto)</code> +<div class="block">Helper to convert the protobuf object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.html#convertToProcedureProto(org.apache.hadoop.hbase.ProcedureInfo)">convertToProcedureProto</a></strong>(<a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase">ProcedureInfo</a> procInfo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase">ProcedureState</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.html#convertToProcedureState(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureState)">convertToProcedureState</a></strong>(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureState state)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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#toString()" title="class or interface in java.lang">toString</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> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ProcedureUtil()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProcedureUtil</h4> +<pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/ProcedureUtil.html#line.33">ProcedureUtil</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="convertToProcedureProto(org.apache.hadoop.hbase.ProcedureInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertToProcedureProto</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure <a href="../../../../src-html/org/apache/hadoop/hbase/ProcedureUtil.html#line.40">convertToProcedureProto</a>(<a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase">ProcedureInfo</a> procInfo)</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Convert the current <a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase"><code>ProcedureInfo</code></a> into a Protocol Buffers Procedure + instance.</dd></dl> +</li> +</ul> +<a name="convert(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public static <a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase">ProcedureInfo</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ProcedureUtil.html#line.74">convert</a>(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.Procedure procProto)</pre> +<div class="block">Helper to convert the protobuf object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Convert the current Protocol Buffers Procedure to <a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase"><code>ProcedureInfo</code></a> + instance.</dd></dl> +</li> +</ul> +<a name="convertToProcedureState(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureState)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>convertToProcedureState</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase">ProcedureState</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ProcedureUtil.html#line.88">convertToProcedureState</a>(org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureState state)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProcedureUtil.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.ForeignExceptionMsg.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ProcedureUtil.html" target="_top">Frames</a></li> +<li><a href="ProcedureUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f58e71c6/devapidocs/org/apache/hadoop/hbase/RegionException.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/RegionException.html b/devapidocs/org/apache/hadoop/hbase/RegionException.html index 5cb7965..af5d48d 100644 --- a/devapidocs/org/apache/hadoop/hbase/RegionException.html +++ b/devapidocs/org/apache/hadoop/hbase/RegionException.html @@ -35,7 +35,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.ForeignExceptionMsg.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -278,7 +278,7 @@ extends <a href="../../../../org/apache/hadoop/hbase/HBaseIOException.html" titl </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/hadoop/hbase/ProcedureInfo.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ProcedureUtil.ForeignExceptionMsg.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f58e71c6/devapidocs/org/apache/hadoop/hbase/ScheduledChore.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ScheduledChore.html b/devapidocs/org/apache/hadoop/hbase/ScheduledChore.html index 9c6faf1..c3f93dc 100644 --- a/devapidocs/org/apache/hadoop/hbase/ScheduledChore.html +++ b/devapidocs/org/apache/hadoop/hbase/ScheduledChore.html @@ -551,7 +551,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.132">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 with which this Chore repeats execution when scheduled.</dd></dl> +<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> </li> </ul> <a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable, int, long)"> @@ -564,7 +564,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <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 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 +<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 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> </li> @@ -580,9 +580,9 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. 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 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><dd><code>unit</code> - The unit that is used to measure period and initialDelay</dd></dl> +<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 + 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> </li> </ul> </li> @@ -636,8 +636,8 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <li class="blockList"> <h4>getTimeBetweenRuns</h4> <pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.219">getTimeBetweenRuns</a>()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>How long has it been since this chore last run. Useful for checking if the chore has - missed its scheduled start time by too large of a margin</dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>How long in millis has it been since this chore last run. Useful for checking if the + chore has missed its scheduled start time by too large of a margin</dd></dl> </li> </ul> <a name="missedStartTime()"> @@ -656,7 +656,8 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getMaximumAllowedTimeBetweenRuns</h4> -<pre>private double <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.231">getMaximumAllowedTimeBetweenRuns</a>()</pre> +<pre>private double <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.234">getMaximumAllowedTimeBetweenRuns</a>()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>max allowed time in millis between runs.</dd></dl> </li> </ul> <a name="isValidTime(long)"> @@ -665,7 +666,9 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>isValidTime</h4> -<pre>private boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.236">isValidTime</a>(long time)</pre> +<pre>private boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.243">isValidTime</a>(long time)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - in system millis</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if time is earlier or equal to current milli time</dd></dl> </li> </ul> <a name="triggerNow()"> @@ -674,7 +677,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>triggerNow</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.243">triggerNow</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.250">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> </li> </ul> @@ -684,7 +687,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>setChoreServicer</h4> -<pre>void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.251">setChoreServicer</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.ChoreServicer.html" title="interface in org.apache.hadoop.hbase">ScheduledChore.ChoreServicer</a> service)</pre> +<pre>void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.258">setChoreServicer</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.ChoreServicer.html" title="interface in org.apache.hadoop.hbase">ScheduledChore.ChoreServicer</a> service)</pre> </li> </ul> <a name="cancel()"> @@ -693,7 +696,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>cancel</h4> -<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.261">cancel</a>()</pre> +<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.268">cancel</a>()</pre> </li> </ul> <a name="cancel(boolean)"> @@ -702,7 +705,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>cancel</h4> -<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.265">cancel</a>(boolean mayInterruptIfRunning)</pre> +<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.272">cancel</a>(boolean mayInterruptIfRunning)</pre> </li> </ul> <a name="getName()"> @@ -711,7 +714,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <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.271">getName</a>()</pre> +<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.278">getName</a>()</pre> </li> </ul> <a name="getStopper()"> @@ -720,7 +723,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getStopper</h4> -<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.275">getStopper</a>()</pre> +<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.282">getStopper</a>()</pre> </li> </ul> <a name="getPeriod()"> @@ -729,7 +732,8 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getPeriod</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.279">getPeriod</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.289">getPeriod</a>()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>period to execute chore in getTimeUnit() units</dd></dl> </li> </ul> <a name="getInitialDelay()"> @@ -738,7 +742,8 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getInitialDelay</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.283">getInitialDelay</a>()</pre> +<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.296">getInitialDelay</a>()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>initial delay before executing chore in getTimeUnit() units</dd></dl> </li> </ul> <a name="getTimeUnit()"> @@ -747,7 +752,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <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.287">getTimeUnit</a>()</pre> +<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.300">getTimeUnit</a>()</pre> </li> </ul> <a name="isInitialChoreComplete()"> @@ -756,7 +761,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>isInitialChoreComplete</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.291">isInitialChoreComplete</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.304">isInitialChoreComplete</a>()</pre> </li> </ul> <a name="getChoreServicer()"> @@ -765,7 +770,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getChoreServicer</h4> -<pre><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.ChoreServicer.html" title="interface in org.apache.hadoop.hbase">ScheduledChore.ChoreServicer</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.296">getChoreServicer</a>()</pre> +<pre><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.ChoreServicer.html" title="interface in org.apache.hadoop.hbase">ScheduledChore.ChoreServicer</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.309">getChoreServicer</a>()</pre> </li> </ul> <a name="getTimeOfLastRun()"> @@ -774,7 +779,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getTimeOfLastRun</h4> -<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.301">getTimeOfLastRun</a>()</pre> +<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.314">getTimeOfLastRun</a>()</pre> </li> </ul> <a name="getTimeOfThisRun()"> @@ -783,7 +788,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>getTimeOfThisRun</h4> -<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.306">getTimeOfThisRun</a>()</pre> +<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.319">getTimeOfThisRun</a>()</pre> </li> </ul> <a name="isScheduled()"> @@ -792,7 +797,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>isScheduled</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.313">isScheduled</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.326">isScheduled</a>()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true when this Chore is scheduled with a ChoreService</dd></dl> </li> </ul> @@ -802,7 +807,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>choreForTesting</h4> -<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.318">choreForTesting</a>()</pre> +<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.331">choreForTesting</a>()</pre> </li> </ul> <a name="chore()"> @@ -811,7 +816,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>chore</h4> -<pre>protected abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.325">chore</a>()</pre> +<pre>protected abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.338">chore</a>()</pre> <div class="block">The task to execute on each scheduled execution of the Chore</div> </li> </ul> @@ -821,7 +826,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>initialChore</h4> -<pre>protected boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.331">initialChore</a>()</pre> +<pre>protected boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.344">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> </li> @@ -832,7 +837,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockList"> <li class="blockList"> <h4>cleanup</h4> -<pre>protected void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.339">cleanup</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.352">cleanup</a>()</pre> <div class="block">Override to run cleanup tasks when the Chore encounters an error and must stop running</div> </li> </ul> @@ -842,7 +847,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable. <ul class="blockListLast"> <li class="blockList"> <h4>toString</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.343">toString</a>()</pre> +<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.356">toString</a>()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><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></code></dd> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f58e71c6/devapidocs/org/apache/hadoop/hbase/class-use/Abortable.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/class-use/Abortable.html b/devapidocs/org/apache/hadoop/hbase/class-use/Abortable.html index bbb672e..cfef65e 100644 --- a/devapidocs/org/apache/hadoop/hbase/class-use/Abortable.html +++ b/devapidocs/org/apache/hadoop/hbase/class-use/Abortable.html @@ -294,11 +294,11 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></td> -<td class="colLast"><span class="strong">SimpleRpcScheduler.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/SimpleRpcScheduler.html#abortable">abortable</a></strong></code> </td> +<td class="colLast"><span class="strong">RpcExecutor.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcExecutor.html#abortable">abortable</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></td> -<td class="colLast"><span class="strong">RpcExecutor.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcExecutor.html#abortable">abortable</a></strong></code> </td> +<td class="colLast"><span class="strong">SimpleRpcScheduler.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/SimpleRpcScheduler.html#abortable">abortable</a></strong></code> </td> </tr> </tbody> </table> @@ -522,17 +522,17 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></code></td> -<td class="colLast"><span class="strong">RpcSchedulerFactory.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/regionserver/RpcSchedulerFactory.html#create(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.hbase.ipc.PriorityFunction,%20org.apache.hadoop.hbase.Abortable)">create</a></strong>(org.apache.hadoop.conf.Configuration conf, +<td class="colLast"><span class="strong">SimpleRpcSchedulerFactory.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.html#create(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.hbase.ipc.PriorityFunction,%20org.apache.hadoop.hbase.Abortable)">create</a></strong>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/ipc/PriorityFunction.html" title="interface in org.apache.hadoop.hbase.ipc">PriorityFunction</a> priority, - <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> server)</code> -<div class="block">Constructs a <a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc"><code>RpcScheduler</code></a>.</div> -</td> + <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> server)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></code></td> -<td class="colLast"><span class="strong">SimpleRpcSchedulerFactory.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.html#create(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.hbase.ipc.PriorityFunction,%20org.apache.hadoop.hbase.Abortable)">create</a></strong>(org.apache.hadoop.conf.Configuration conf, +<td class="colLast"><span class="strong">RpcSchedulerFactory.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/regionserver/RpcSchedulerFactory.html#create(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.hbase.ipc.PriorityFunction,%20org.apache.hadoop.hbase.Abortable)">create</a></strong>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/ipc/PriorityFunction.html" title="interface in org.apache.hadoop.hbase.ipc">PriorityFunction</a> priority, - <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> server)</code> </td> + <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> server)</code> +<div class="block">Constructs a <a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc"><code>RpcScheduler</code></a>.</div> +</td> </tr> </tbody> </table> @@ -600,13 +600,13 @@ </tr> <tbody> <tr class="altColor"> -<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></td> -<td class="colLast"><span class="strong">ReplicationPeersZKImpl.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/replication/ReplicationPeersZKImpl.html#abortable">abortable</a></strong></code> </td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></td> <td class="colLast"><span class="strong">ReplicationStateZKBase.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/replication/ReplicationStateZKBase.html#abortable">abortable</a></strong></code> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></td> +<td class="colLast"><span class="strong">ReplicationPeersZKImpl.</span><code><strong><a href="../../../../../org/apache/hadoop/hbase/replication/ReplicationPeersZKImpl.html#abortable">abortable</a></strong></code> </td> +</tr> </tbody> </table> <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
