http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/execution/DirectSubmitter.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/execution/DirectSubmitter.html b/site/javadoc/r1.1.0/org/apache/edgent/execution/DirectSubmitter.html new file mode 100644 index 0000000..c1db88a --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/execution/DirectSubmitter.html @@ -0,0 +1,259 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>DirectSubmitter (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DirectSubmitter (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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"> +<!-- --> +</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"> +<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/DirectSubmitter.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/edgent/execution/Configs.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/DirectSubmitter.html" target="_top">Frames</a></li> +<li><a href="DirectSubmitter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.edgent.execution</div> +<h2 title="Interface DirectSubmitter" class="title">Interface DirectSubmitter<E,J extends <a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>E</code> - the executable type</dd> +<dd><code>J</code> - the submitted executable's future</dd> +</dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a><E,J></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/edgent/providers/development/DevelopmentProvider.html" title="class in org.apache.edgent.providers.development">DevelopmentProvider</a>, <a href="../../../../org/apache/edgent/providers/direct/DirectProvider.html" title="class in org.apache.edgent.providers.direct">DirectProvider</a>, <a href="../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DirectSubmitter<E,J extends <a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></span> +extends <a href="../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a><E,J></pre> +<div class="block">An interface for submission of an executable + that is executed directly within the current + virtual machine.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/DirectSubmitter.html#getServices--">getServices</a></span>()</code> +<div class="block">Access to services.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.execution.Submitter"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.edgent.execution.<a href="../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a></h3> +<code><a href="../../../../org/apache/edgent/execution/Submitter.html#submit-E-">submit</a>, <a href="../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-">submit</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getServices--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getServices</h4> +<pre><a href="../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a> getServices()</pre> +<div class="block">Access to services. + + Since any executables are executed directly within + the current virtual machine, callers may register + services that are visible to the executable + and its elements.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Service container for this submitter.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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"> +<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/DirectSubmitter.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/edgent/execution/Configs.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/DirectSubmitter.html" target="_top">Frames</a></li> +<li><a href="DirectSubmitter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Action.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Action.html b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Action.html new file mode 100644 index 0000000..b32c3b0 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Action.html @@ -0,0 +1,399 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>Job.Action (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Job.Action (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</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"> +<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/Job.Action.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/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.Action.html" target="_top">Frames</a></li> +<li><a href="Job.Action.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.edgent.execution</div> +<h2 title="Enum Job.Action" class="title">Enum Job.Action</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.execution.Job.Action</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">Job.Action</span> +extends java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a>></pre> +<div class="block">Actions which trigger <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution"><code>Job.State</code></a> transitions.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#CLOSE">CLOSE</a></span></code> +<div class="block">Close the job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#INITIALIZE">INITIALIZE</a></span></code> +<div class="block">Initialize the job</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#PAUSE">PAUSE</a></span></code> +<div class="block">Pause the execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#RESUME">RESUME</a></span></code> +<div class="block">Resume the execution</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#START">START</a></span></code> +<div class="block">Start the execution.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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 id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="INITIALIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INITIALIZE</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> INITIALIZE</pre> +<div class="block">Initialize the job</div> +</li> +</ul> +<a name="START"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>START</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> START</pre> +<div class="block">Start the execution.</div> +</li> +</ul> +<a name="PAUSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PAUSE</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> PAUSE</pre> +<div class="block">Pause the execution.</div> +</li> +</ul> +<a name="RESUME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RESUME</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> RESUME</pre> +<div class="block">Resume the execution</div> +</li> +</ul> +<a name="CLOSE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLOSE</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> CLOSE</pre> +<div class="block">Close the job.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Job.Action c : Job.Action.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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"> +<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/Job.Action.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.Action.html" target="_top">Frames</a></li> +<li><a href="Job.Action.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Health.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Health.html b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Health.html new file mode 100644 index 0000000..552bd19 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.Health.html @@ -0,0 +1,356 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>Job.Health (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Job.Health (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</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"> +<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/Job.Health.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/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.Health.html" target="_top">Frames</a></li> +<li><a href="Job.Health.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.edgent.execution</div> +<h2 title="Enum Job.Health" class="title">Enum Job.Health</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.execution.Job.Health</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">Job.Health</span> +extends java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a>></pre> +<div class="block">Enumeration for the summarized health indicator of the graph nodes.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Health.html#HEALTHY">HEALTHY</a></span></code> +<div class="block">All graph nodes in the job are healthy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Health.html#UNHEALTHY">UNHEALTHY</a></span></code> +<div class="block">The execution of at least one graph node in the job has stopped + because of an abnormal condition.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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 id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Health.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Health.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="HEALTHY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HEALTHY</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a> HEALTHY</pre> +<div class="block">All graph nodes in the job are healthy.</div> +</li> +</ul> +<a name="UNHEALTHY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNHEALTHY</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a> UNHEALTHY</pre> +<div class="block">The execution of at least one graph node in the job has stopped + because of an abnormal condition.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Job.Health c : Job.Health.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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"> +<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/Job.Health.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.Health.html" target="_top">Frames</a></li> +<li><a href="Job.Health.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.State.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.State.html b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.State.html new file mode 100644 index 0000000..c651b37 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.State.html @@ -0,0 +1,399 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>Job.State (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Job.State (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</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"> +<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/Job.State.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/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.State.html" target="_top">Frames</a></li> +<li><a href="Job.State.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.edgent.execution</div> +<h2 title="Enum Job.State" class="title">Enum Job.State</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.execution.Job.State</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">Job.State</span> +extends java.lang.Enum<<a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a>></pre> +<div class="block">States of a graph job.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#CLOSED">CLOSED</a></span></code> +<div class="block">All the graph nodes are closed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#CONSTRUCTED">CONSTRUCTED</a></span></code> +<div class="block">Initial state, the graph nodes are not yet initialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#INITIALIZED">INITIALIZED</a></span></code> +<div class="block">All the graph nodes have been initialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#PAUSED">PAUSED</a></span></code> +<div class="block">All the graph nodes are paused.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#RUNNING">RUNNING</a></span></code> +<div class="block">All the graph nodes are processing data.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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 id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="CONSTRUCTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONSTRUCTED</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> CONSTRUCTED</pre> +<div class="block">Initial state, the graph nodes are not yet initialized.</div> +</li> +</ul> +<a name="INITIALIZED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INITIALIZED</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> INITIALIZED</pre> +<div class="block">All the graph nodes have been initialized.</div> +</li> +</ul> +<a name="RUNNING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RUNNING</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> RUNNING</pre> +<div class="block">All the graph nodes are processing data.</div> +</li> +</ul> +<a name="PAUSED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PAUSED</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> PAUSED</pre> +<div class="block">All the graph nodes are paused.</div> +</li> +</ul> +<a name="CLOSED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLOSED</h4> +<pre>public static final <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> CLOSED</pre> +<div class="block">All the graph nodes are closed.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Job.State c : Job.State.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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"> +<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/Job.State.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.State.html" target="_top">Frames</a></li> +<li><a href="Job.State.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.html b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.html new file mode 100644 index 0000000..0f5a527 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/execution/Job.html @@ -0,0 +1,483 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>Job (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Job (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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"> +<!-- --> +</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"> +<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/Job.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/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.html" target="_top">Frames</a></li> +<li><a href="Job.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.edgent.execution</div> +<h2 title="Interface Job" class="title">Interface Job</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/edgent/graph/spi/execution/AbstractGraphJob.html" title="class in org.apache.edgent.graph.spi.execution">AbstractGraphJob</a>, <a href="../../../../org/apache/edgent/runtime/etiao/EtiaoJob.html" title="class in org.apache.edgent.runtime.etiao">EtiaoJob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Job</span></pre> +<div class="block">Actions and states for execution of an Edgent job. + + The interface provides the main job lifecycle control, taking on the following + execution state values: + + <ul> + <li><b>CONSTRUCTED</b> This job has been constructed but the + nodes are not yet initialized.</li> + <li><b>INITIALIZED</b> This job has been initialized and is + ready to process data. + <li><b>RUNNING</b> This job is processing data.</li> + <li><b>PAUSED</b> This job is paused.</li> + <li><b>CLOSED</b> This job is closed.</li> + </ul> + + The interface provides access to two state values: + <ul> + <li> <a href="../../../../org/apache/edgent/execution/Job.html#getCurrentState--"><code>Current</code></a> - The current state of execution + when the job is not executing a state transition; the source state + while the job is making a state transition after the client code + calls <a href="../../../../org/apache/edgent/execution/Job.html#stateChange-org.apache.edgent.execution.Job.Action-"><code>stateChange(Job.Action)</code></a>.</li> + <li> <a href="../../../../org/apache/edgent/execution/Job.html#getNextState--"><code>Next</code></a> - The destination state while the job + is making a state transition; same as the current state while + the job state is stable (that is, not making a transition).</LI> + </ul> + + The interface provides access to the job nodes + <a href="../../../../org/apache/edgent/execution/Job.html#getHealth--">health summary</a>, described by the following values: + <ul> + <li><b>HEALTHY</b> All graph nodes in the job are healthy.</li> + <li><b>UNHEALTHY</b> At least one graph node in the job is stopped or + stopping.</li> + </ul></div> +</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="memberSummary" 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">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a></span></code> +<div class="block">Actions which trigger <a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution"><code>Job.State</code></a> transitions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a></span></code> +<div class="block">Enumeration for the summarized health indicator of the graph nodes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a></span></code> +<div class="block">States of a graph job.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#complete--">complete</a></span>()</code> +<div class="block">Waits for any outstanding job work to complete.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#complete-long-java.util.concurrent.TimeUnit-">complete</a></span>(long timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Waits for at most the specified time for the job to complete.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getCurrentState--">getCurrentState</a></span>()</code> +<div class="block">Retrieves the current state of this job.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getHealth--">getHealth</a></span>()</code> +<div class="block">Returns the summarized health indicator of the graph nodes.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getId--">getId</a></span>()</code> +<div class="block">Returns the identifier of this job.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getLastError--">getLastError</a></span>()</code> +<div class="block">Returns the last error message caught by the current job execution.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getName--">getName</a></span>()</code> +<div class="block">Returns the name of this job.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#getNextState--">getNextState</a></span>()</code> +<div class="block">Retrieves the next execution state when this job makes a state + transition.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/execution/Job.html#stateChange-org.apache.edgent.execution.Job.Action-">stateChange</a></span>(<a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> action)</code> +<div class="block">Initiates an execution state change.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCurrentState--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentState</h4> +<pre><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> getCurrentState()</pre> +<div class="block">Retrieves the current state of this job.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current state.</dd> +</dl> +</li> +</ul> +<a name="getNextState--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextState</h4> +<pre><a href="../../../../org/apache/edgent/execution/Job.State.html" title="enum in org.apache.edgent.execution">Job.State</a> getNextState()</pre> +<div class="block">Retrieves the next execution state when this job makes a state + transition.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the destination state while in a state transition; + otherwise the same as <a href="../../../../org/apache/edgent/execution/Job.html#getCurrentState--"><code>getCurrentState()</code></a>.</dd> +</dl> +</li> +</ul> +<a name="stateChange-org.apache.edgent.execution.Job.Action-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stateChange</h4> +<pre>void stateChange(<a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution">Job.Action</a> action) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Initiates an execution state change.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>action</code> - which triggers the state change.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if the job is not in an appropriate + state for the requested action, or the action is not supported.</dd> +</dl> +</li> +</ul> +<a name="getHealth--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHealth</h4> +<pre><a href="../../../../org/apache/edgent/execution/Job.Health.html" title="enum in org.apache.edgent.execution">Job.Health</a> getHealth()</pre> +<div class="block">Returns the summarized health indicator of the graph nodes.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the summarized Job node health.</dd> +</dl> +</li> +</ul> +<a name="getLastError--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastError</h4> +<pre>java.lang.String getLastError()</pre> +<div class="block">Returns the last error message caught by the current job execution.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the last error message or an empty string if no error has + been caught.</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this job. The name may be set when the job is + <a href="../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-">submitted</a>. + Implementations may create a job name if one is not specified at submit time.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the job name.</dd> +</dl> +</li> +</ul> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>java.lang.String getId()</pre> +<div class="block">Returns the identifier of this job.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this job identifier.</dd> +</dl> +</li> +</ul> +<a name="complete--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>complete</h4> +<pre>void complete() + throws java.util.concurrent.ExecutionException, + java.lang.InterruptedException</pre> +<div class="block">Waits for any outstanding job work to complete.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.util.concurrent.ExecutionException</code> - if the job execution threw an exception.</dd> +<dd><code>java.lang.InterruptedException</code> - if the current thread was interrupted while waiting</dd> +</dl> +</li> +</ul> +<a name="complete-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>complete</h4> +<pre>void complete(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.util.concurrent.ExecutionException, + java.lang.InterruptedException, + java.util.concurrent.TimeoutException</pre> +<div class="block">Waits for at most the specified time for the job to complete.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeout</code> - the time to wait</dd> +<dd><code>unit</code> - the time unit of the timeout argument</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.util.concurrent.ExecutionException</code> - if the job execution threw an exception.</dd> +<dd><code>java.lang.InterruptedException</code> - if the current thread was interrupted while waiting</dd> +<dd><code>java.util.concurrent.TimeoutException</code> - if the wait timed out</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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"> +<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/Job.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/edgent/execution/Job.Action.html" title="enum in org.apache.edgent.execution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/edgent/execution/Job.html" target="_top">Frames</a></li> +<li><a href="Job.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
