Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html?rev=1618097&r1=1618096&r2=1618097&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html Fri Aug 15 05:28:03 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> <title>MessageCollector (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-28"> +<meta name="date" content="2014-07-23"> <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="MessageCollector (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MessageCollector (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/InitableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/StreamTask.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/MessageCollector.html" target="_top">Frames</a></li> -<li><a href="MessageCollector.html" target="_top">No Frames</a></li> +<li><a href="MessageCollector.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,11 +87,11 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">MessageCollector</span></pre> +<pre>public interface <span class="strong">MessageCollector</span></pre> <div class="block">Used as an interface for the means of sending message envelopes to an output stream. - <p>A MessageCollector is provided on every call to <a href="../../../../org/apache/samza/task/StreamTask.html#process-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-"><code>StreamTask.process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a> and - <a href="../../../../org/apache/samza/task/WindowableTask.html#window-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-"><code>WindowableTask.window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a>. You must use those MessageCollector objects only within + <p>A MessageCollector is provided on every call to <a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>StreamTask.process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a> and + <a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>WindowableTask.window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a>. You must use those MessageCollector objects only within those method calls, and not hold on to a reference for use at any other time.</div> </li> </ul> @@ -114,19 +101,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/MessageCollector.html#send-org.apache.samza.system.OutgoingMessageEnvelope-">send</a></span>(<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/MessageCollector.html#send(org.apache.samza.system.OutgoingMessageEnvelope)">send</a></strong>(<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</code> <div class="block">Sends message envelope out onto specified stream.</div> </td> </tr> @@ -141,11 +128,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="send-org.apache.samza.system.OutgoingMessageEnvelope-"> +<a name="send(org.apache.samza.system.OutgoingMessageEnvelope)"> <!-- --> </a> <ul class="blockListLast"> @@ -153,10 +140,7 @@ var activeTableTab = "activeTableTab"; <h4>send</h4> <pre>void send(<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</pre> <div class="block">Sends message envelope out onto specified stream.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>envelope</code> - Self contained envelope containing message, key and specified stream to be sent to.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - Self contained envelope containing message, key and specified stream to be sent to.</dd></dl> </li> </ul> </li> @@ -167,11 +151,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"> @@ -186,15 +168,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/StreamTask.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/MessageCollector.html" target="_top">Frames</a></li> -<li><a href="MessageCollector.html" target="_top">No Frames</a></li> +<li><a href="MessageCollector.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"><!-- @@ -214,16 +196,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/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html?rev=1618097&r1=1618096&r2=1618097&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html Fri Aug 15 05:28:03 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> <title>StreamTask (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-28"> +<meta name="date" content="2014-07-23"> <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="StreamTask (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StreamTask (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/MessageCollector.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskContext.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/StreamTask.html" target="_top">Frames</a></li> -<li><a href="StreamTask.html" target="_top">No Frames</a></li> +<li><a href="StreamTask.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">StreamTask</span></pre> +<pre>public interface <span class="strong">StreamTask</span></pre> <div class="block">A StreamTask is the basic class on which Samza jobs are implemented. Developers writing Samza jobs begin by implementing this class, which processes messages from the job's input streams and writes messages out to streams via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>. A StreamTask may be augmented by @@ -120,19 +107,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/StreamTask.html#process-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-">process</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/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">process</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/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 once for each message that this StreamTask receives.</div> @@ -149,32 +136,27 @@ 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="process-org.apache.samza.system.IncomingMessageEnvelope-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-"> +<a name="process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>process</h4> <pre>void process(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, - <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/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> <div class="block">Called once for each message that this StreamTask receives.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>envelope</code> - Contains the received deserialized message and key, and also information regarding the stream and - partition of which the message was received from.</dd> -<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>envelope</code> - Contains the received deserialized message and key, and also information regarding the stream and + partition of which the message was received from.</dd><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 process 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> @@ -185,11 +167,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"> @@ -204,15 +184,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskContext.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/StreamTask.html" target="_top">Frames</a></li> -<li><a href="StreamTask.html" target="_top">No Frames</a></li> +<li><a href="StreamTask.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"><!-- @@ -232,16 +212,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/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html?rev=1618097&r1=1618096&r2=1618097&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html Fri Aug 15 05:28:03 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> <title>TaskContext (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-28"> +<meta name="date" content="2014-07-23"> <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="TaskContext (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TaskContext (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":6,"i1":6,"i2":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/StreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.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/TaskContext.html" target="_top">Frames</a></li> -<li><a href="TaskContext.html" target="_top">No Frames</a></li> +<li><a href="TaskContext.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">TaskContext</span></pre> +<pre>public interface <span class="strong">TaskContext</span></pre> <div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div> </li> @@ -111,27 +98,27 @@ 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/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskContext.html#getMetricsRegistry--">getMetricsRegistry</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getMetricsRegistry()">getMetricsRegistry</a></strong>()</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskContext.html#getPartition--">getPartition</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getPartition()">getPartition</a></strong>()</code> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskContext.html#getStore-java.lang.String-">getStore</a></span>(java.lang.String name)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getStore(java.lang.String)">getStore</a></strong>(java.lang.String name)</code> </td> </tr> </table> </li> @@ -144,11 +131,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="getMetricsRegistry--"> +<a name="getMetricsRegistry()"> <!-- --> </a> <ul class="blockList"> @@ -157,7 +144,7 @@ var activeTableTab = "activeTableTab"; <pre><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> getMetricsRegistry()</pre> </li> </ul> -<a name="getPartition--"> +<a name="getPartition()"> <!-- --> </a> <ul class="blockList"> @@ -166,7 +153,7 @@ var activeTableTab = "activeTableTab"; <pre><a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> getPartition()</pre> </li> </ul> -<a name="getStore-java.lang.String-"> +<a name="getStore(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> @@ -183,11 +170,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"> @@ -202,15 +187,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/task/TaskCoordinator.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/TaskContext.html" target="_top">Frames</a></li> -<li><a href="TaskContext.html" target="_top">No Frames</a></li> +<li><a href="TaskContext.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"><!-- @@ -230,16 +215,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/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html?rev=1618097&r1=1618096&r2=1618097&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html Fri Aug 15 05:28:03 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> <title>TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-28"> +<meta name="date" content="2014-07-23"> <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/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html?rev=1618097&r1=1618096&r2=1618097&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html Fri Aug 15 05:28:03 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> <title>TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-28"> +<meta name="date" content="2014-07-23"> <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 ======= -->
