You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by cr...@apache.org on 2015/01/25 00:00:16 UTC
svn commit: r1654593 [28/33] - in /samza/site: ./ contribute/
learn/documentation/latest/api/javadocs/
learn/documentation/latest/api/javadocs/org/apache/samza/
learn/documentation/latest/api/javadocs/org/apache/samza/checkpoint/
learn/documentation/la...
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html Sat Jan 24 23:00:15 2015
@@ -1,335 +1,354 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-TaskCoordinator.RequestScope (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-12-09">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
-
-<SCRIPT type="text/javascript">
-function windowTitle()
-{
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="TaskCoordinator.RequestScope (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>TaskCoordinator.RequestScope (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-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.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<A NAME="navbar_top"><!-- --></A>
-<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_top_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TaskCoordinator.RequestScope.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/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/WindowableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">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>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_top"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.task</FONT>
-<BR>
-Enum TaskCoordinator.RequestScope</H2>
-<PRE>
-java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum<<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A>>
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.task.TaskCoordinator.RequestScope</B>
-</PRE>
-<DL>
-<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable<<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A>></DD>
-</DL>
-<DL>
-<DT><B>Enclosing interface:</B><DD><A HREF="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</A></DD>
-</DL>
-<HR>
-<DL>
-<DT><PRE>public static enum <B>TaskCoordinator.RequestScope</B><DT>extends java.lang.Enum<<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A>></DL>
-</PRE>
-
-<P>
-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
+<div class="header">
+<div class="subTitle">org.apache.samza.task</div>
+<h2 title="Enum TaskCoordinator.RequestScope" class="title">Enum TaskCoordinator.RequestScope</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Enum<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.task.TaskCoordinator.RequestScope</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></dd>
+</dl>
+<dl>
+<dt>Enclosing interface:</dt>
+<dd><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public static enum <span class="typeNameLabel">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
whether those requests apply only to the current task, or to all tasks in the
- current container.
-<P>
-
-<P>
-<HR>
-
-<P>
+ current container.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
-
-<A NAME="enum_constant_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Enum Constant Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#ALL_TASKS_IN_CONTAINER">ALL_TASKS_IN_CONTAINER</A></B></CODE>
-
-<BR>
- Indicates that a request applies to all tasks in the current container.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#CURRENT_TASK">CURRENT_TASK</A></B></CODE>
-
-<BR>
- Indicates that a request applies only to the task making the call.</TD>
-</TR>
-</TABLE>
-
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.summary">
+<!-- -->
+</a>
+<h3>Enum Constant Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
+<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Enum Constant and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#ALL_TASKS_IN_CONTAINER">ALL_TASKS_IN_CONTAINER</a></span></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>
+<div class="block">Indicates that a request applies only to the task making the call.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
<!-- ========== METHOD SUMMARY =========== -->
-
-<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String name)</CODE>
-
-<BR>
- Returns the enum constant of this type with the specified name.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A>[]</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#values()">values</A></B>()</CODE>
-
-<BR>
- Returns an array containing the constants of this enum type, in
-the order they are declared.</TD>
-</TR>
-</TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>
-</TR>
-</TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../org/apache/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>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../org/apache/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>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Enum</h3>
+<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Object</h3>
+<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
-
-<A NAME="enum_constant_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Enum Constant Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="CURRENT_TASK"><!-- --></A><H3>
-CURRENT_TASK</H3>
-<PRE>
-public static final <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> <B>CURRENT_TASK</B></PRE>
-<DL>
-<DD>Indicates that a request applies only to the task making the call.
-<P>
-<DL>
-</DL>
-</DL>
-<HR>
-
-<A NAME="ALL_TASKS_IN_CONTAINER"><!-- --></A><H3>
-ALL_TASKS_IN_CONTAINER</H3>
-<PRE>
-public static final <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> <B>ALL_TASKS_IN_CONTAINER</B></PRE>
-<DL>
-<DD>Indicates that a request applies to all tasks in the current container.
-<P>
-<DL>
-</DL>
-</DL>
-
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.detail">
+<!-- -->
+</a>
+<h3>Enum Constant Detail</h3>
+<a name="CURRENT_TASK">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CURRENT_TASK</h4>
+<pre>public static final <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> CURRENT_TASK</pre>
+<div class="block">Indicates that a request applies only to the task making the call.</div>
+</li>
+</ul>
+<a name="ALL_TASKS_IN_CONTAINER">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>ALL_TASKS_IN_CONTAINER</h4>
+<pre>public static final <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> ALL_TASKS_IN_CONTAINER</pre>
+<div class="block">Indicates that a request applies to all tasks in the current container.</div>
+</li>
+</ul>
+</li>
+</ul>
<!-- ============ METHOD DETAIL ========== -->
-
-<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="values()"><!-- --></A><H3>
-values</H3>
-<PRE>
-public static <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A>[] <B>values</B>()</PRE>
-<DL>
-<DD>Returns an array containing the constants of this enum type, in
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="values--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>values</h4>
+<pre>public static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>[] values()</pre>
+<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (TaskCoordinator.RequestScope c : TaskCoordinator.RequestScope.values())
System.out.println(c);
-</pre>
-<P>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
-the order they are declared</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
-valueOf</H3>
-<PRE>
-public static <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> <B>valueOf</B>(java.lang.String name)</PRE>
-<DL>
-<DD>Returns the enum constant of this type with the specified name.
-The string must match <I>exactly</I> an identifier used to declare an
+</pre></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array containing the constants of this enum type, in the order they are declared</dd>
+</dl>
+</li>
+</ul>
+<a name="valueOf-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>valueOf</h4>
+<pre>public static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> valueOf(java.lang.String name)</pre>
+<div class="block">Returns the enum constant of this type with the specified name.
+The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
-<DT><B>Returns:</B><DD>the enum constant with the specified name
-<DT><B>Throws:</B>
-<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
-with the specified name
-<DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</DL>
-</DD>
-</DL>
+not permitted.)</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the enum constant to be returned.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the enum constant with the specified name</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
+<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= END OF CLASS DATA ========= -->
-<HR>
-
-
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<A NAME="navbar_bottom"><!-- --></A>
-<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_bottom_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TaskCoordinator.RequestScope.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/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/WindowableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">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>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_bottom"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/TaskCoordinator.html Sat Jan 24 23:00:15 2015
@@ -1,179 +1,190 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-TaskCoordinator (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-12-09">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
-
-<SCRIPT type="text/javascript">
-function windowTitle()
-{
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="TaskCoordinator (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>TaskCoordinator (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-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.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+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 ======= -->
-<A NAME="navbar_top"><!-- --></A>
-<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_top_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TaskCoordinator.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/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>
+</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>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_top"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.class.summary">Nested</a> | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.task</FONT>
-<BR>
-Interface TaskCoordinator</H2>
-<HR>
-<DL>
-<DT><PRE>public interface <B>TaskCoordinator</B></DL>
-</PRE>
-
-<P>
-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
+<div class="header">
+<div class="subTitle">org.apache.samza.task</div>
+<h2 title="Interface TaskCoordinator" class="title">Interface TaskCoordinator</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">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
+ 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
a container.
<p>
This interface may evolve over time.
- </p>
-<P>
-
-<P>
-<HR>
-
-<P>
+ </p></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-<A NAME="nested_class_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Nested Class Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static class</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A></B></CODE>
-
-<BR>
- 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>.</TD>
-</TR>
-</TABLE>
-
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
+<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Interface and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static class </code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></span></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>
+</td>
+</tr>
+</table>
+</li>
+</ul>
<!-- ========== METHOD SUMMARY =========== -->
-
-<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)">commit</A></B>(<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> scope)</CODE>
-
-<BR>
- Requests that Samza should write out a checkpoint, from which a task can restart
- after failure.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)">shutdown</A></B>(<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> scope)</CODE>
-
-<BR>
- Requests that the container should be shut down.</TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/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>
+<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">
+<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>
+<div class="block">Requests that the container should be shut down.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
-
-<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><!-- --></A><H3>
-commit</H3>
-<PRE>
-void <B>commit</B>(<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> scope)</PRE>
-<DL>
-<DD>Requests that Samza should write out a checkpoint, from which a task can restart
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="commit-org.apache.samza.task.TaskCoordinator.RequestScope-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>commit</h4>
+<pre>void commit(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</pre>
+<div class="block">Requests that Samza should write out a checkpoint, from which a task can restart
after failure.
<p>If <code>CURRENT_TASK</code> is given, a checkpoint is only written for the
@@ -184,20 +195,21 @@ void <B>commit</B>(<A HREF="../../../../
intervals (using the <code>task.commit.ms</code> property), those time-based
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.
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>scope</CODE> - Which tasks are being asked to commit.</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><!-- --></A><H3>
-shutdown</H3>
-<PRE>
-void <B>shutdown</B>(<A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</A> scope)</PRE>
-<DL>
-<DD>Requests that the container should be shut down.
+ 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>
+</li>
+</ul>
+<a name="shutdown-org.apache.samza.task.TaskCoordinator.RequestScope-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>shutdown</h4>
+<pre>void shutdown(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</pre>
+<div class="block">Requests that the container should be shut down.
<p>If <code>CURRENT_TASK</code> is given, that indicates a willingness of the current
task to shut down. All tasks in the container (including the one that requested
@@ -209,72 +221,80 @@ void <B>shutdown</B>(<A HREF="../../../.
<p>If <code>ALL_TASKS_IN_CONTAINER</code> is given, the container will shut down
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.
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>scope</CODE> - The approach we should use for shutting down the container.</DL>
-</DD>
-</DL>
+ 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>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= END OF CLASS DATA ========= -->
-<HR>
-
-
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<A NAME="navbar_bottom"><!-- --></A>
-<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_bottom_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><B>NEXT CLASS</B></A></FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TaskCoordinator.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/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>
+</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>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_bottom"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.class.summary">Nested</a> | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/WindowableTask.html Sat Jan 24 23:00:15 2015
@@ -1,220 +1,238 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:23 PST 2014 -->
-<TITLE>
-WindowableTask (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-12-09">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
-
-<SCRIPT type="text/javascript">
-function windowTitle()
-{
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="WindowableTask (samza-api 0.9.0-SNAPSHOT API)";
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>WindowableTask (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-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="WindowableTask (samza-api 0.9.0-SNAPSHOT API)";
+ }
}
-}
-</SCRIPT>
-<NOSCRIPT>
-</NOSCRIPT>
-
-</HEAD>
-
-<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
-
-
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<A NAME="navbar_top"><!-- --></A>
-<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_top_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top"><B>FRAMES</B></A>
- <A HREF="WindowableTask.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">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>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_top"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.samza.task</FONT>
-<BR>
-Interface WindowableTask</H2>
-<HR>
-<DL>
-<DT><PRE>public interface <B>WindowableTask</B></DL>
-</PRE>
-
-<P>
-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
+<div class="header">
+<div class="subTitle">org.apache.samza.task</div>
+<h2 title="Interface WindowableTask" class="title">Interface WindowableTask</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">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
- window. The window method will be called even if no messages are received for a particular StreamTask.
-<P>
-
-<P>
-<HR>
-
-<P>
-
+ window. The window method will be called even if no messages are received for a particular StreamTask.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
-
-<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)">window</A></B>(<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>
-
-<BR>
- Called by TaskRunner for each implementing task at the end of every specified window.</TD>
-</TR>
-</TABLE>
-
-<P>
-
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/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,
+ <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>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
-
-<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"><!-- --></A><H3>
-window</H3>
-<PRE>
-void <B>window</B>(<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>
-<DL>
-<DD>Called by TaskRunner for each implementing task at the end of every specified window.
-<P>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>collector</CODE> - Contains the means of sending message envelopes to the output stream. The collector must only
+<ul class="blockList">
+<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>
+<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>
+<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
be used during the current call to the window method; you should not reuse the collector between invocations
- of this method.<DD><CODE>coordinator</CODE> - Manages execution of tasks.
-<DT><B>Throws:</B>
-<DD><CODE>java.lang.Exception</CODE> - Any exception types encountered during the execution of the processing task.</DL>
-</DD>
-</DL>
+ 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>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
<!-- ========= END OF CLASS DATA ========= -->
-<HR>
-
-
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<A NAME="navbar_bottom"><!-- --></A>
-<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
-<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
-<A NAME="navbar_bottom_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top"><B>FRAMES</B></A>
- <A HREF="WindowableTask.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">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>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
}
//-->
-</SCRIPT>
-<NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
-</NOSCRIPT>
-
-
-</FONT></TD>
-</TR>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_bottom"></A>
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-
-</BODY>
-</HTML>
+</body>
+</html>
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html?rev=1654593&r1=1654592&r2=1654593&view=diff
==============================================================================
--- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html (original)
+++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-frame.html Sat Jan 24 23:00:15 2015
@@ -1,55 +1,30 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 -->
-<TITLE>
-org.apache.samza.task (samza-api 0.9.0-SNAPSHOT API)
-</TITLE>
-
-<META NAME="date" CONTENT="2014-12-09">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
-
-
-</HEAD>
-
-<BODY BGCOLOR="white">
-<FONT size="+1" CLASS="FrameTitleFont">
-<A HREF="../../../../org/apache/samza/task/package-summary.html" target="classFrame">org.apache.samza.task</A></FONT>
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
-Interfaces</FONT>
-<FONT CLASS="FrameItemFont">
-<BR>
-<A HREF="ClosableTask.html" title="interface in org.apache.samza.task" target="classFrame"><I>ClosableTask</I></A>
-<BR>
-<A HREF="InitableTask.html" title="interface in org.apache.samza.task" target="classFrame"><I>InitableTask</I></A>
-<BR>
-<A HREF="MessageCollector.html" title="interface in org.apache.samza.task" target="classFrame"><I>MessageCollector</I></A>
-<BR>
-<A HREF="StreamTask.html" title="interface in org.apache.samza.task" target="classFrame"><I>StreamTask</I></A>
-<BR>
-<A HREF="TaskContext.html" title="interface in org.apache.samza.task" target="classFrame"><I>TaskContext</I></A>
-<BR>
-<A HREF="TaskCoordinator.html" title="interface in org.apache.samza.task" target="classFrame"><I>TaskCoordinator</I></A>
-<BR>
-<A HREF="WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><I>WindowableTask</I></A></FONT></TD>
-</TR>
-</TABLE>
-
-
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
-Enums</FONT>
-<FONT CLASS="FrameItemFont">
-<BR>
-<A HREF="TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task" target="classFrame">TaskCoordinator.RequestScope</A></FONT></TD>
-</TR>
-</TABLE>
-
-
-</BODY>
-</HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_31) on Fri Jan 23 11:05:49 PST 2015 -->
+<title>org.apache.samza.task (samza-api 0.9.0-SNAPSHOT API)</title>
+<meta name="date" content="2015-01-23">
+<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="WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><span class="interfaceName">WindowableTask</span></a></li>
+</ul>
+<h2 title="Enums">Enums</h2>
+<ul title="Enums">
+<li><a href="TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task" target="classFrame">TaskCoordinator.RequestScope</a></li>
+</ul>
+</div>
+</body>
+</html>