| <!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>TwillSpecification (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="TwillSpecification (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/TwillSpecification.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/TwillRunResources.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.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/TwillSpecification.html" target="_top">Frames</a></li> |
| <li><a href="TwillSpecification.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.twill.api</div> |
| <h2 title="Interface TwillSpecification" class="title">Interface TwillSpecification</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TwillSpecification</span></pre> |
| <div class="block">Represents specification of a <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.html" title="class in org.apache.twill.api">TwillSpecification.Builder</a></strong></code> |
| <div class="block">Builder for constructing instance of <a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api"><code>TwillSpecification</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.Order.html" title="interface in org.apache.twill.api">TwillSpecification.Order</a></strong></code> |
| <div class="block">Defines execution order.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.PlacementPolicy</a></strong></code> |
| <div class="block">Defines a container placement policy.</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="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/EventHandlerSpecification.html" title="interface in org.apache.twill.api">EventHandlerSpecification</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.html#getEventHandler()">getEventHandler</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/TwillSpecification.html#getName()">getName</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/twill/api/TwillSpecification.Order.html" title="interface in org.apache.twill.api">TwillSpecification.Order</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.html#getOrders()">getOrders</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.PlacementPolicy</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.html#getPlacementPolicies()">getPlacementPolicies</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../org/apache/twill/api/RuntimeSpecification.html" title="interface in org.apache.twill.api">RuntimeSpecification</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillSpecification.html#getRunnables()">getRunnables</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="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</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> getName()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Name of the application.</dd></dl> |
| </li> |
| </ul> |
| <a name="getRunnables()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRunnables</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../org/apache/twill/api/RuntimeSpecification.html" title="interface in org.apache.twill.api">RuntimeSpecification</a>> getRunnables()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A map from <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> name to <a href="../../../../org/apache/twill/api/RuntimeSpecification.html" title="interface in org.apache.twill.api"><code>RuntimeSpecification</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getOrders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrders</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/twill/api/TwillSpecification.Order.html" title="interface in org.apache.twill.api">TwillSpecification.Order</a>> getOrders()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Returns a list of runnable names that should be executed in the given order.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPlacementPolicies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlacementPolicies</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.PlacementPolicy</a>> getPlacementPolicies()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Returns all <a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api"><code>TwillSpecification.PlacementPolicy</code></a> for this application.</dd></dl> |
| </li> |
| </ul> |
| <a name="getEventHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEventHandler</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| <a href="../../../../org/apache/twill/api/EventHandlerSpecification.html" title="interface in org.apache.twill.api">EventHandlerSpecification</a> getEventHandler()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../../org/apache/twill/api/EventHandlerSpecification.html" title="interface in org.apache.twill.api"><code>EventHandlerSpecification</code></a> for the <a href="../../../../org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><code>EventHandler</code></a> to be used for this application, |
| or <code>null</code> if no event handler has been provided.</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/TwillSpecification.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/TwillRunResources.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.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/TwillSpecification.html" target="_top">Frames</a></li> |
| <li><a href="TwillSpecification.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 © 2013 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
