Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":9,"i1":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.RequestScope.html" target="_top">No Frames</a></li> +<li><a href="TaskCoordinator.RequestScope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -74,18 +61,18 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method.summary">Method</a></li> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -121,11 +108,11 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public static enum <span class="typeNameLabel">TaskCoordinator.RequestScope</span> +<pre>public static enum <span class="strong">TaskCoordinator.RequestScope</span> extends java.lang.Enum<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></pre> <div class="block">A task can make requests to the Samza framework while processing messages, such as - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>TaskCoordinator.commit(RequestScope)</code></a> and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>TaskCoordinator.shutdown(RequestScope)</code></a>. This enum is used to indicate + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.commit(RequestScope)</code></a> and + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.shutdown(RequestScope)</code></a>. This enum is used to indicate whether those requests apply only to the current task, or to all tasks in the current container.</div> </li> @@ -136,22 +123,22 @@ extends java.lang.Enum<<a href="../.. <li class="blockList"> <!-- =========== ENUM CONSTANT SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="enum.constant.summary"> +<li class="blockList"><a name="enum_constant_summary"> <!-- --> </a> <h3>Enum Constant Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Enum Constant and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#ALL_TASKS_IN_CONTAINER">ALL_TASKS_IN_CONTAINER</a></span></code> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#ALL_TASKS_IN_CONTAINER">ALL_TASKS_IN_CONTAINER</a></strong></code> <div class="block">Indicates that a request applies to all tasks in the current container.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#CURRENT_TASK">CURRENT_TASK</a></span></code> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#CURRENT_TASK">CURRENT_TASK</a></strong></code> <div class="block">Indicates that a request applies only to the task making the call.</div> </td> </tr> @@ -160,39 +147,39 @@ extends java.lang.Enum<<a href="../.. </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> <div class="block">Returns the enum constant of this type with the specified name.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#values--">values</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#values()">values</a></strong>()</code> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> <!-- --> </a> <h3>Methods inherited from class java.lang.Enum</h3> <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> </ul> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -208,7 +195,7 @@ the order they are declared.</div> <li class="blockList"> <!-- ============ ENUM CONSTANT DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="enum.constant.detail"> +<li class="blockList"><a name="enum_constant_detail"> <!-- --> </a> <h3>Enum Constant Detail</h3> @@ -236,11 +223,11 @@ the order they are declared.</div> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="values--"> +<a name="values()"> <!-- --> </a> <ul class="blockList"> @@ -254,13 +241,10 @@ over the constants as follows: for (TaskCoordinator.RequestScope c : TaskCoordinator.RequestScope.values()) System.out.println(c); </pre></div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an array containing the constants of this enum type, in the order they are declared</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> </li> </ul> -<a name="valueOf-java.lang.String-"> +<a name="valueOf(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> @@ -271,15 +255,11 @@ for (TaskCoordinator.RequestScope c : Ta The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - the name of the enum constant to be returned.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the enum constant with the specified name</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> -<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> -</dl> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> </li> </ul> </li> @@ -290,11 +270,9 @@ not permitted.)</div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -309,15 +287,15 @@ not permitted.)</div> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.RequestScope.html" target="_top">No Frames</a></li> +<li><a href="TaskCoordinator.RequestScope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -335,18 +313,18 @@ not permitted.)</div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method.summary">Method</a></li> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":6,"i1":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.html" target="_top">No Frames</a></li> +<li><a href="TaskCoordinator.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -73,19 +60,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -100,7 +87,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">TaskCoordinator</span></pre> +<pre>public interface <span class="strong">TaskCoordinator</span></pre> <div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to allow the user code to request actions from the Samza framework, including committing the current checkpoints to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within @@ -116,11 +103,11 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<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> @@ -128,10 +115,10 @@ var activeTableTab = "activeTableTab"; </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></strong></code> <div class="block">A task can make requests to the Samza framework while processing messages, such as - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>commit(RequestScope)</code></a> and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>shutdown(RequestScope)</code></a>.</div> + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>commit(RequestScope)</code></a> and + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>shutdown(RequestScope)</code></a>.</div> </td> </tr> </table> @@ -139,26 +126,26 @@ var activeTableTab = "activeTableTab"; </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit-org.apache.samza.task.TaskCoordinator.RequestScope-">commit</a></span>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)">commit</a></strong>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> <div class="block">Requests that Samza should write out a checkpoint, from which a task can restart after failure.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-">shutdown</a></span>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)">shutdown</a></strong>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> <div class="block">Requests that the container should be shut down.</div> </td> </tr> @@ -173,11 +160,11 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="commit-org.apache.samza.task.TaskCoordinator.RequestScope-"> +<a name="commit(org.apache.samza.task.TaskCoordinator.RequestScope)"> <!-- --> </a> <ul class="blockList"> @@ -196,13 +183,10 @@ var activeTableTab = "activeTableTab"; commits are not affected by calling this method. Any commits you request explicitly are in addition to timer-based commits. You can set <code>task.commit.ms=-1</code> if you don't want commits to happen automatically.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scope</code> - Which tasks are being asked to commit.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - Which tasks are being asked to commit.</dd></dl> </li> </ul> -<a name="shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-"> +<a name="shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"> <!-- --> </a> <ul class="blockListLast"> @@ -222,10 +206,7 @@ var activeTableTab = "activeTableTab"; immediately after it has finished processing the current message. Any buffers of pending writes are flushed, but no further messages will be processed in this container.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scope</code> - The approach we should use for shutting down the container.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - The approach we should use for shutting down the container.</dd></dl> </li> </ul> </li> @@ -236,11 +217,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -255,15 +234,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.html" target="_top">No Frames</a></li> +<li><a href="TaskCoordinator.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -280,19 +259,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListener.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListener.html" target="_top">No Frames</a></li> +<li><a href="TaskLifecycleListener.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -100,7 +87,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">TaskLifecycleListener</span></pre> +<pre>public interface <span class="strong">TaskLifecycleListener</span></pre> <div class="block">Used to get before/after notifications before initializing/closing all tasks in a given container (JVM/process).</div> </li> @@ -111,55 +98,55 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterClose-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">afterClose</a></span>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterClose</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called after all tasks in TaskRunner are closed.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterInit-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">afterInit</a></span>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterInit</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called after all tasks in TaskRunner are initialized.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterProcess-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">afterProcess</a></span>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterProcess</a></strong>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called after a message is processed by a task.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeClose-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">beforeClose</a></span>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeClose</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called before all tasks in TaskRunner are closed.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeInit-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">beforeInit</a></span>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeInit</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called before all tasks in TaskRunner are initialized.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeProcess-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">beforeProcess</a></span>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeProcess</a></strong>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> <div class="block">Called before a message is processed by a task.</div> @@ -176,108 +163,82 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="beforeInit-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="beforeInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>beforeInit</h4> <pre>void beforeInit(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called before all tasks in TaskRunner are initialized.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd></dl> </li> </ul> -<a name="afterInit-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="afterInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>afterInit</h4> <pre>void afterInit(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called after all tasks in TaskRunner are initialized.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd></dl> </li> </ul> -<a name="beforeProcess-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="beforeProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>beforeProcess</h4> <pre>void beforeProcess(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called before a message is processed by a task.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>envelope</code> - The envelope to be processed by the StreamTask.</dd> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that's about to process a message.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - The envelope to be processed by the StreamTask.</dd><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's about to process a message.</dd></dl> </li> </ul> -<a name="afterProcess-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="afterProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>afterProcess</h4> <pre>void afterProcess(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called after a message is processed by a task.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>envelope</code> - The envelope that was processed by the StreamTask.</dd> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that just processed a message.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - The envelope that was processed by the StreamTask.</dd><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that just processed a message.</dd></dl> </li> </ul> -<a name="beforeClose-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="beforeClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>beforeClose</h4> <pre>void beforeClose(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called before all tasks in TaskRunner are closed.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that's about to be shutdown.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's about to be shutdown.</dd></dl> </li> </ul> -<a name="afterClose-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"> +<a name="afterClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>afterClose</h4> <pre>void afterClose(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> + <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</pre> <div class="block">Called after all tasks in TaskRunner are closed.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>config</code> - Config for the Samza job.</dd> -<dd><code>context</code> - TaskContext for the StreamTask that was just shutdown.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that was just shutdown.</dd></dl> </li> </ul> </li> @@ -288,11 +249,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -307,15 +266,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListener.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListener.html" target="_top">No Frames</a></li> +<li><a href="TaskLifecycleListener.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -335,16 +294,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>TaskLifecycleListenerFactory (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskLifecycleListenerFactory (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TaskLifecycleListenerFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListenerFactory.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListenerFactory.html" target="_top">No Frames</a></li> +<li><a href="TaskLifecycleListenerFactory.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -100,7 +87,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">TaskLifecycleListenerFactory</span></pre> +<pre>public interface <span class="strong">TaskLifecycleListenerFactory</span></pre> <div class="block">Build a <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div> </li> </ul> @@ -110,19 +97,19 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html#getLifecyleListener-java.lang.String-org.apache.samza.config.Config-">getLifecyleListener</a></span>(java.lang.String name, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html#getLifecyleListener(java.lang.String,%20org.apache.samza.config.Config)">getLifecyleListener</a></strong>(java.lang.String name, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> </tr> </table> @@ -136,18 +123,18 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getLifecyleListener-java.lang.String-org.apache.samza.config.Config-"> +<a name="getLifecyleListener(java.lang.String, org.apache.samza.config.Config)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getLifecyleListener</h4> <pre><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a> getLifecyleListener(java.lang.String name, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> </li> </ul> </li> @@ -158,11 +145,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -177,15 +162,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListenerFactory.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListenerFactory.html" target="_top">No Frames</a></li> +<li><a href="TaskLifecycleListenerFactory.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -205,16 +190,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>WindowableTask (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="WindowableTask (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="WindowableTask (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top">Frames</a></li> -<li><a href="WindowableTask.html" target="_top">No Frames</a></li> +<li><a href="WindowableTask.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -100,7 +87,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">WindowableTask</span></pre> +<pre>public interface <span class="strong">WindowableTask</span></pre> <div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on a specified time interval (via configuration). This can be used to implement direct time-based windowing or, with a frequent window interval, windowing based on some other condition which is checked during the call to @@ -113,19 +100,19 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/WindowableTask.html#window-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-">window</a></span>(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">window</a></strong>(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator)</code> <div class="block">Called by TaskRunner for each implementing task at the end of every specified window.</div> </td> @@ -141,29 +128,25 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="window-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-"> +<a name="window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>window</h4> <pre>void window(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator) - throws java.lang.Exception</pre> + <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator) + throws java.lang.Exception</pre> <div class="block">Called by TaskRunner for each implementing task at the end of every specified window.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>collector</code> - Contains the means of sending message envelopes to the output stream. The collector must only +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>collector</code> - Contains the means of sending message envelopes to the output stream. The collector must only be used during the current call to the window method; you should not reuse the collector between invocations - of this method.</dd> -<dd><code>coordinator</code> - Manages execution of tasks.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.Exception</code> - Any exception types encountered during the execution of the processing task.</dd> -</dl> + of this method.</dd><dd><code>coordinator</code> - Manages execution of tasks.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - Any exception types encountered during the execution of the processing task.</dd></dl> </li> </ul> </li> @@ -174,11 +157,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -193,15 +174,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top">Frames</a></li> -<li><a href="WindowableTask.html" target="_top">No Frames</a></li> +<li><a href="WindowableTask.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -221,16 +202,16 @@ var activeTableTab = "activeTableTab"; <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html Fri Sep 19 16:33:36 2014 @@ -2,26 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:32 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <h1 class="bar"><a href="../../../../org/apache/samza/task/package-summary.html" target="classFrame">org.apache.samza.task</a></h1> <div class="indexContainer"> <h2 title="Interfaces">Interfaces</h2> <ul title="Interfaces"> -<li><a href="ClosableTask.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">ClosableTask</span></a></li> -<li><a href="InitableTask.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">InitableTask</span></a></li> -<li><a href="MessageCollector.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">MessageCollector</span></a></li> -<li><a href="StreamTask.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">StreamTask</span></a></li> -<li><a href="TaskContext.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">TaskContext</span></a></li> -<li><a href="TaskCoordinator.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">TaskCoordinator</span></a></li> -<li><a href="TaskLifecycleListener.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">TaskLifecycleListener</span></a></li> -<li><a href="TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">TaskLifecycleListenerFactory</span></a></li> -<li><a href="WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">WindowableTask</span></a></li> +<li><a href="ClosableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>ClosableTask</i></a></li> +<li><a href="InitableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>InitableTask</i></a></li> +<li><a href="MessageCollector.html" title="interface in org.apache.samza.task" target="classFrame"><i>MessageCollector</i></a></li> +<li><a href="StreamTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>StreamTask</i></a></li> +<li><a href="TaskContext.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskContext</i></a></li> +<li><a href="TaskCoordinator.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskCoordinator</i></a></li> +<li><a href="TaskLifecycleListener.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskLifecycleListener</i></a></li> +<li><a href="TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskLifecycleListenerFactory</i></a></li> +<li><a href="WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>WindowableTask</i></a></li> </ul> <h2 title="Enums">Enums</h2> <ul title="Enums"> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-summary.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-summary.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-summary.html Fri Sep 19 16:33:36 2014 @@ -2,20 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:32 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -23,11 +18,9 @@ <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -42,15 +35,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li> +<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -64,7 +57,7 @@ //--> </script> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -74,7 +67,7 @@ <div class="contentContainer"> <ul class="blockList"> <li class="blockList"> -<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Interface</th> @@ -148,7 +141,7 @@ </table> </li> <li class="blockList"> -<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Enum</th> @@ -159,8 +152,8 @@ <td class="colFirst"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></td> <td class="colLast"> <div class="block">A task can make requests to the Samza framework while processing messages, such as - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>TaskCoordinator.commit(RequestScope)</code></a> and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-"><code>TaskCoordinator.shutdown(RequestScope)</code></a>.</div> + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.commit(RequestScope)</code></a> and + <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.shutdown(RequestScope)</code></a>.</div> </td> </tr> </tbody> @@ -169,11 +162,9 @@ </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -188,15 +179,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li> +<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -210,7 +201,7 @@ //--> </script> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
