http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/2bd71bb1/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillPreparer.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillPreparer.html b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillPreparer.html new file mode 100644 index 0000000..ca5de1c --- /dev/null +++ b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillPreparer.html @@ -0,0 +1,637 @@ +<!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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TwillPreparer (Apache Twill 0.6.0-incubating API)</title> +<meta name="date" content="2015-07-24"> +<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="TwillPreparer (Apache Twill 0.6.0-incubating 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/TwillPreparer.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/twill/api/TwillController.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillPreparer.html" target="_top">Frames</a></li> +<li><a href="TwillPreparer.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.twill.api</div> +<h2 title="Interface TwillPreparer" class="title">Interface TwillPreparer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">TwillPreparer</span></pre> +<div class="block">This interface exposes methods to set up the Twill runtime environment and start a Twill application.</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="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><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#addJVMOptions(java.lang.String)">addJVMOptions</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> options)</code> +<div class="block">This methods adds extra JVM options that will be passed to the java command line for every runnable + of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#addLogHandler(org.apache.twill.api.logging.LogHandler)">addLogHandler</a></strong>(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</code> +<div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving an application log.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#addSecureStore(org.apache.twill.api.SecureStore)">addSecureStore</a></strong>(<a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api">SecureStore</a> secureStore)</code> +<div class="block">Adds security credentials for the runtime environment to gives application access to resources.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#enableDebugging(boolean,%20java.lang.String...)">enableDebugging</a></strong>(boolean doSuspend, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... runnables)</code> +<div class="block">Enable debugging for runnables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#enableDebugging(java.lang.String...)">enableDebugging</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... runnables)</code> +<div class="block">Enable debugging for runnables, without suspending the virtual machine to wait for the debugger.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#setJVMOptions(java.lang.String)">setJVMOptions</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> options)</code> +<div class="block">This methods sets the extra JVM options that will be passed to the java command line for every runnable + of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevel(org.apache.twill.api.logging.LogEntry.Level)">setLogLevel</a></strong>(<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a> logLevel)</code> +<div class="block">Set the log level for Twill applications running in a container.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#setSchedulerQueue(java.lang.String)">setSchedulerQueue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Sets the name of the scheduler queue to use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#setUser(java.lang.String)">setUser</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This method will be removed in future version.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#start()">start</a></strong>()</code> +<div class="block">Starts the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationArguments(java.lang.Iterable)">withApplicationArguments</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> args)</code> +<div class="block">Sets the list of arguments that will be passed to the application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationArguments(java.lang.String...)">withApplicationArguments</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... args)</code> +<div class="block">Sets the list of arguments that will be passed to the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationClassPaths(java.lang.Iterable)">withApplicationClassPaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> classPaths)</code> +<div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationClassPaths(java.lang.String...)">withApplicationClassPaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... classPaths)</code> +<div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withArguments(java.lang.String,%20java.lang.Iterable)">withArguments</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> runnableName, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> args)</code> +<div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withArguments(java.lang.String,%20java.lang.String...)">withArguments</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> runnableName, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... args)</code> +<div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withBundlerClassAcceptor(org.apache.twill.api.ClassAcceptor)">withBundlerClassAcceptor</a></strong>(<a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a> classAcceptor)</code> +<div class="block">Uses <a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api"><code>ClassAcceptor</code></a> to determine the classes to include in the bundle jar for + ApplicationMaster and all runnables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths(java.lang.Iterable)">withClassPaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> classPaths)</code> +<div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths(java.lang.String...)">withClassPaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... classPaths)</code> +<div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies(java.lang.Class...)">withDependencies</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... classes)</code> +<div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies(java.lang.Iterable)">withDependencies</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> classes)</code> +<div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources(java.lang.Iterable)">withResources</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a>> resources)</code> +<div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources(java.net.URI...)">withResources</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a>... resources)</code> +<div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</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="addLogHandler(org.apache.twill.api.logging.LogHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addLogHandler</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addLogHandler(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</pre> +<div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving an application log.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - The <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="setUser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUser</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +<a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setUser(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This method will be removed in future version.</i></div> +<div class="block">Sets the user name that runs the application. Default value is get from <code>"user.name"</code> by calling + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/System.html?is-external=true#getProperty(java.lang.String)" title="class or interface in java.lang"><code>System.getProperty(String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - User name</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="setSchedulerQueue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSchedulerQueue</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setSchedulerQueue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Sets the name of the scheduler queue to use.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the scheduler queue</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="setJVMOptions(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setJVMOptions</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setJVMOptions(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> options)</pre> +<div class="block">This methods sets the extra JVM options that will be passed to the java command line for every runnable + of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance. + + This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid + options could cause application not able to start.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - extra JVM options.</dd></dl> +</li> +</ul> +<a name="addJVMOptions(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addJVMOptions</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addJVMOptions(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> options)</pre> +<div class="block">This methods adds extra JVM options that will be passed to the java command line for every runnable + of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance. + + This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid + options could cause application not able to start.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - extra JVM options.</dd></dl> +</li> +</ul> +<a name="enableDebugging(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enableDebugging</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> enableDebugging(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... runnables)</pre> +<div class="block">Enable debugging for runnables, without suspending the virtual machine to wait for the debugger. + This replaces any previous debug settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnables</code> - the names of runnables to enable for debugging. If empty, it means all runnables.</dd></dl> +</li> +</ul> +<a name="enableDebugging(boolean, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enableDebugging</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> enableDebugging(boolean doSuspend, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... runnables)</pre> +<div class="block">Enable debugging for runnables. This replaces any previous debug settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doSuspend</code> - whether the virtual machines should be supended until the debugger connects. This + option allows to debug a container from the very beginning. Note that in that case, + the container cannot notify the controller of its debug port until the debugger is + attached - you must figure out where it is running using the YARN console or APIs.</dd><dd><code>runnables</code> - the names of runnables to enable for debugging. If empty, it means all runnables.</dd></dl> +</li> +</ul> +<a name="withApplicationArguments(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withApplicationArguments</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationArguments(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... args)</pre> +<div class="block">Sets the list of arguments that will be passed to the application. The arguments can be retrieved + from <a href="../../../../org/apache/twill/api/TwillContext.html#getApplicationArguments()"><code>TwillContext.getApplicationArguments()</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of arguments.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withApplicationArguments(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withApplicationArguments</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationArguments(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> args)</pre> +<div class="block">Sets the list of arguments that will be passed to the application. The arguments can be retrieved + from <a href="../../../../org/apache/twill/api/TwillContext.html#getApplicationArguments()"><code>TwillContext.getApplicationArguments()</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Iterable of arguments.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withArguments(java.lang.String, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withArguments</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withArguments(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> runnableName, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... args)</pre> +<div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name. + The arguments can be retrieved from <a href="../../../../org/apache/twill/api/TwillContext.html#getArguments()"><code>TwillContext.getArguments()</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd><dd><code>args</code> - Array of arguments.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withArguments(java.lang.String, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withArguments</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withArguments(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> runnableName, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> args)</pre> +<div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name. + The arguments can be retrieved from <a href="../../../../org/apache/twill/api/TwillContext.html#getArguments()"><code>TwillContext.getArguments()</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd><dd><code>args</code> - Iterable of arguments.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withDependencies(java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withDependencies</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withDependencies(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... classes)</pre> +<div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies(java.lang.Iterable)"><code>withDependencies(Iterable)</code></a></dd></dl> +</li> +</ul> +<a name="withDependencies(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withDependencies</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withDependencies(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> classes)</pre> +<div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself. + E.g. Class name used in <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true#forName(java.lang.String)" title="class or interface in java.lang"><code>Class.forName(String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classes</code> - set of classes to add to dependency list for generating the deployment jar.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withResources(java.net.URI...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withResources</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withResources(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a>... resources)</pre> +<div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources(java.lang.Iterable)"><code>withResources(Iterable)</code></a></dd></dl> +</li> +</ul> +<a name="withResources(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withResources</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withResources(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a>> resources)</pre> +<div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>. + Useful for adding extra resource files or libraries that are not traceable from the application itself. + If the URI is a jar file, classes inside would be loadable by the ClassLoader. If the URI is a directory, + everything underneath would be available.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resources</code> - Set of URI to the resources.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="withClassPaths(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withClassPaths</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withClassPaths(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... classPaths)</pre> +<div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths(java.lang.Iterable)"><code>withClassPaths(Iterable)</code></a></dd></dl> +</li> +</ul> +<a name="withClassPaths(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withClassPaths</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withClassPaths(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> classPaths)</pre> +<div class="block">Adds the set of paths to the classpath on the target machine for all runnables. + Note that the paths would be just added without verification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classPaths</code> - Set of classpaths</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd></dl> +</li> +</ul> +<a name="withApplicationClassPaths(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withApplicationClassPaths</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationClassPaths(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... classPaths)</pre> +<div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd></dl> +</li> +</ul> +<a name="withApplicationClassPaths(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withApplicationClassPaths</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationClassPaths(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> classPaths)</pre> +<div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd></dl> +</li> +</ul> +<a name="withBundlerClassAcceptor(org.apache.twill.api.ClassAcceptor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withBundlerClassAcceptor</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withBundlerClassAcceptor(<a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a> classAcceptor)</pre> +<div class="block">Uses <a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api"><code>ClassAcceptor</code></a> to determine the classes to include in the bundle jar for + ApplicationMaster and all runnables.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classAcceptor</code> - to specify which classes to include in the bundle jar</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd></dl> +</li> +</ul> +<a name="addSecureStore(org.apache.twill.api.SecureStore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSecureStore</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addSecureStore(<a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api">SecureStore</a> secureStore)</pre> +<div class="block">Adds security credentials for the runtime environment to gives application access to resources.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>secureStore</code> - Contains security token available for the runtime environment.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="setLogLevel(org.apache.twill.api.logging.LogEntry.Level)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogLevel</h4> +<pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setLogLevel(<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a> logLevel)</pre> +<div class="block">Set the log level for Twill applications running in a container.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>logLevel</code> - the <code>LogEntry.Level</code> that should be set. + The level match the <code>Logback</code> levels.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd></dl> +</li> +</ul> +<a name="start()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>start</h4> +<pre><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a> start()</pre> +<div class="block">Starts the application.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for controlling the running application.</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><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/TwillPreparer.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/twill/api/TwillController.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillPreparer.html" target="_top">Frames</a></li> +<li><a href="TwillPreparer.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 © 2013 <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/incubator-twill/blob/2bd71bb1/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunResources.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunResources.html b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunResources.html new file mode 100644 index 0000000..19ee339 --- /dev/null +++ b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunResources.html @@ -0,0 +1,296 @@ +<!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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TwillRunResources (Apache Twill 0.6.0-incubating API)</title> +<meta name="date" content="2015-07-24"> +<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="TwillRunResources (Apache Twill 0.6.0-incubating 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/TwillRunResources.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/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunResources.html" target="_top">Frames</a></li> +<li><a href="TwillRunResources.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.twill.api</div> +<h2 title="Interface TwillRunResources" class="title">Interface TwillRunResources</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">TwillRunResources</span></pre> +<div class="block">Information about the container the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> + is running in.</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="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><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getContainerId()">getContainerId</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getDebugPort()">getDebugPort</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getHost()">getHost</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getInstanceId()">getInstanceId</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getLogLevel()">getLogLevel</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getMemoryMB()">getMemoryMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunResources.html#getVirtualCores()">getVirtualCores</a></strong>()</code> </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="getInstanceId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstanceId</h4> +<pre>int getInstanceId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>instance id of the runnable.</dd></dl> +</li> +</ul> +<a name="getVirtualCores()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVirtualCores</h4> +<pre>int getVirtualCores()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of cores the runnable is allowed to use. YARN must be at least v2.1.0 and + it must be configured to use cgroups in order for this to be a reflection of truth.</dd></dl> +</li> +</ul> +<a name="getMemoryMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMemoryMB</h4> +<pre>int getMemoryMB()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>amount of memory in MB the runnable is allowed to use.</dd></dl> +</li> +</ul> +<a name="getHost()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHost</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getHost()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the host the runnable is running on.</dd></dl> +</li> +</ul> +<a name="getContainerId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContainerId</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getContainerId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>id of the container the runnable is running in.</dd></dl> +</li> +</ul> +<a name="getDebugPort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDebugPort</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> getDebugPort()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the debug port of the container's JVM, or null if not debug-enabled.</dd></dl> +</li> +</ul> +<a name="getLogLevel()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLogLevel</h4> +<pre><a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a> getLogLevel()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the enabled log level for the container where the runnable is running in.</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><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/TwillRunResources.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/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunResources.html" target="_top">Frames</a></li> +<li><a href="TwillRunResources.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 © 2013 <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/incubator-twill/blob/2bd71bb1/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnable.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnable.html b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnable.html new file mode 100644 index 0000000..9f2950e --- /dev/null +++ b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnable.html @@ -0,0 +1,303 @@ +<!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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TwillRunnable (Apache Twill 0.6.0-incubating API)</title> +<meta name="date" content="2015-07-24"> +<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="TwillRunnable (Apache Twill 0.6.0-incubating 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/TwillRunnable.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/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunnable.html" target="_top">Frames</a></li> +<li><a href="TwillRunnable.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.twill.api</div> +<h2 title="Interface TwillRunnable" class="title">Interface TwillRunnable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a>, <a href="../../../../org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext">BundledJarRunnable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TwillRunnable</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></pre> +<div class="block">The <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> interface should be implemented by any + class whose instances are intended to be executed in a Twill cluster.</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="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><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api">TwillRunnableSpecification</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnable.html#configure()">configure</a></strong>()</code> +<div class="block">Called at submission time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnable.html#destroy()">destroy</a></strong>()</code> +<div class="block">Called when the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>Runnable.run()</code></a> completed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnable.html#handleCommand(org.apache.twill.api.Command)">handleCommand</a></strong>(<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a> command)</code> +<div class="block">Called when a command is received.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnable.html#initialize(org.apache.twill.api.TwillContext)">initialize</a></strong>(<a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a> context)</code> +<div class="block">Called when the container process starts.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnable.html#stop()">stop</a></strong>()</code> +<div class="block">Requests to stop the running service.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Runnable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang">run</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="configure()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configure</h4> +<pre><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api">TwillRunnableSpecification</a> configure()</pre> +<div class="block">Called at submission time. Executed on the client side.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api"><code>TwillRunnableSpecification</code></a> built by <a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.html" title="class in org.apache.twill.api"><code>TwillRunnableSpecification.Builder</code></a>.</dd></dl> +</li> +</ul> +<a name="initialize(org.apache.twill.api.TwillContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>void initialize(<a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a> context)</pre> +<div class="block">Called when the container process starts. Executed in container machine. If any exception is thrown from this + method, this runnable won't get retry.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - Contains information about the runtime context.</dd></dl> +</li> +</ul> +<a name="handleCommand(org.apache.twill.api.Command)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleCommand</h4> +<pre>void handleCommand(<a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a> command) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Called when a command is received. A normal return denotes the command has been processed successfully, otherwise + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> should be thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - Contains details of the command.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="stop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop()</pre> +<div class="block">Requests to stop the running service.</div> +</li> +</ul> +<a name="destroy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>destroy</h4> +<pre>void destroy()</pre> +<div class="block">Called when the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>Runnable.run()</code></a> completed. Useful for doing + resource cleanup. This method would only get called if the call to <a href="../../../../org/apache/twill/api/TwillRunnable.html#initialize(org.apache.twill.api.TwillContext)"><code>initialize(TwillContext)</code></a> was + successful.</div> +</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/TwillRunnable.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/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunnable.html" target="_top">Frames</a></li> +<li><a href="TwillRunnable.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 © 2013 <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/incubator-twill/blob/2bd71bb1/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html new file mode 100644 index 0000000..74e3bd7 --- /dev/null +++ b/src/site/resources/apidocs-0.6.0-incubating/org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html @@ -0,0 +1,262 @@ +<!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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TwillRunnableSpecification.Builder.AfterConfigs (Apache Twill 0.6.0-incubating API)</title> +<meta name="date" content="2015-07-24"> +<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="TwillRunnableSpecification.Builder.AfterConfigs (Apache Twill 0.6.0-incubating 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/TwillRunnableSpecification.Builder.AfterConfigs.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/twill/api/TwillRunnableSpecification.Builder.html" title="class in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.AfterName.html" title="class in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html" target="_top">Frames</a></li> +<li><a href="TwillRunnableSpecification.Builder.AfterConfigs.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><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.twill.api</div> +<h2 title="Class TwillRunnableSpecification.Builder.AfterConfigs" class="title">Class TwillRunnableSpecification.Builder.AfterConfigs</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/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.twill.api.TwillRunnableSpecification.Builder.AfterConfigs</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.html" title="class in org.apache.twill.api">TwillRunnableSpecification.Builder</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">TwillRunnableSpecification.Builder.AfterConfigs</span> +extends <a href="http://download.oracle.com/javase/6/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"> +<!-- ======== 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html#TwillRunnableSpecification.Builder.AfterConfigs()">TwillRunnableSpecification.Builder.AfterConfigs</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><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api">TwillRunnableSpecification</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html#build()">build</a></strong>()</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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/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="TwillRunnableSpecification.Builder.AfterConfigs()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TwillRunnableSpecification.Builder.AfterConfigs</h4> +<pre>public TwillRunnableSpecification.Builder.AfterConfigs()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api">TwillRunnableSpecification</a> build()</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/TwillRunnableSpecification.Builder.AfterConfigs.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/twill/api/TwillRunnableSpecification.Builder.html" title="class in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.AfterName.html" title="class in org.apache.twill.api"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html" target="_top">Frames</a></li> +<li><a href="TwillRunnableSpecification.Builder.AfterConfigs.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><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 © 2013 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
