Skip to content

Commit

Permalink
update default docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Marz committed Aug 2, 2012
1 parent 104e81b commit f00db2f
Show file tree
Hide file tree
Showing 521 changed files with 89,634 additions and 1,881 deletions.
424 changes: 415 additions & 9 deletions doc/allclasses-frame.html
View file

Large diffs are not rendered by default.

424 changes: 415 additions & 9 deletions doc/allclasses-noframe.html
View file

Large diffs are not rendered by default.

394 changes: 376 additions & 18 deletions doc/backtype/storm/Config.html
View file

Large diffs are not rendered by default.

40 changes: 38 additions & 2 deletions doc/backtype/storm/Constants.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:43 PDT 2012 -->
<TITLE>
Constants
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

Expand Down Expand Up @@ -116,6 +116,22 @@ <H2>
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../backtype/storm/Constants.html#COORDINATED_STREAM_ID">COORDINATED_STREAM_ID</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../backtype/storm/Constants.html#SYSTEM_COMPONENT_ID">SYSTEM_COMPONENT_ID</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../backtype/storm/Constants.html#SYSTEM_TICK_STREAM_ID">SYSTEM_TICK_STREAM_ID</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
Expand Down Expand Up @@ -176,6 +192,26 @@ <H2>
<DL>
</DL>
</DL>
<HR>

<A NAME="SYSTEM_COMPONENT_ID"><!-- --></A><H3>
SYSTEM_COMPONENT_ID</H3>
<PRE>
public static final java.lang.String <B>SYSTEM_COMPONENT_ID</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#backtype.storm.Constants.SYSTEM_COMPONENT_ID">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SYSTEM_TICK_STREAM_ID"><!-- --></A><H3>
SYSTEM_TICK_STREAM_ID</H3>
<PRE>
public static final java.lang.String <B>SYSTEM_TICK_STREAM_ID</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#backtype.storm.Constants.SYSTEM_TICK_STREAM_ID">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/ILocalCluster.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:43 PDT 2012 -->
<TITLE>
ILocalCluster
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/ILocalDRPC.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:43 PDT 2012 -->
<TITLE>
ILocalDRPC
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/StormSubmitter.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:43 PDT 2012 -->
<TITLE>
StormSubmitter
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

Expand Down
10 changes: 5 additions & 5 deletions doc/backtype/storm/clojure/ClojureBolt.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:08 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:45 PDT 2012 -->
<TITLE>
ClojureBolt
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down Expand Up @@ -155,7 +155,7 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../backtype/storm/clojure/ClojureBolt.html#execute(backtype.storm.tuple.Tuple)">execute</A></B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="class in backtype.storm.tuple">Tuple</A>&nbsp;input)</CODE>
<TD><CODE><B><A HREF="../../../backtype/storm/clojure/ClojureBolt.html#execute(backtype.storm.tuple.Tuple)">execute</A></B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="interface in backtype.storm.tuple">Tuple</A>&nbsp;input)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process a single tuple of input.</TD>
Expand Down Expand Up @@ -246,15 +246,15 @@ <H2>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../backtype/storm/task/IBolt.html#prepare(java.util.Map, backtype.storm.task.TopologyContext, backtype.storm.task.OutputCollector)">prepare</A></CODE> in interface <CODE><A HREF="../../../backtype/storm/task/IBolt.html" title="interface in backtype.storm.task">IBolt</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stormConf</CODE> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.<DD><CODE>context</CODE> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.<DD><CODE>collector</CODE> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is not thread-safe and should be saved as an instance variable of this bolt object.</DL>
<DT><B>Parameters:</B><DD><CODE>stormConf</CODE> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.<DD><CODE>context</CODE> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.<DD><CODE>collector</CODE> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(backtype.storm.tuple.Tuple)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="class in backtype.storm.tuple">Tuple</A>&nbsp;input)</PRE>
public void <B>execute</B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="interface in backtype.storm.tuple">Tuple</A>&nbsp;input)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../backtype/storm/task/IBolt.html#execute(backtype.storm.tuple.Tuple)">IBolt</A></CODE></B></DD>
<DD>Process a single tuple of input. The Tuple object contains metadata on it
Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/ClojureSpout.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:45 PDT 2012 -->
<TITLE>
ClojureSpout
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/RichShellBolt.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:45 PDT 2012 -->
<TITLE>
RichShellBolt
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/RichShellSpout.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:45 PDT 2012 -->
<TITLE>
RichShellSpout
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/package-frame.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:51 PDT 2012 -->
<TITLE>
backtype.storm.clojure
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/package-summary.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:51 PDT 2012 -->
<TITLE>
backtype.storm.clojure
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
4 changes: 2 additions & 2 deletions doc/backtype/storm/clojure/package-tree.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:09 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:51 PDT 2012 -->
<TITLE>
backtype.storm.clojure Class Hierarchy
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down
10 changes: 5 additions & 5 deletions doc/backtype/storm/coordination/BatchBoltExecutor.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:46 PDT 2012 -->
<TITLE>
BatchBoltExecutor
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down Expand Up @@ -169,7 +169,7 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../backtype/storm/coordination/BatchBoltExecutor.html#execute(backtype.storm.tuple.Tuple)">execute</A></B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="class in backtype.storm.tuple">Tuple</A>&nbsp;input)</CODE>
<TD><CODE><B><A HREF="../../../backtype/storm/coordination/BatchBoltExecutor.html#execute(backtype.storm.tuple.Tuple)">execute</A></B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="interface in backtype.storm.tuple">Tuple</A>&nbsp;input)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process a single tuple of input.</TD>
Expand Down Expand Up @@ -284,15 +284,15 @@ <H2>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../backtype/storm/task/IBolt.html#prepare(java.util.Map, backtype.storm.task.TopologyContext, backtype.storm.task.OutputCollector)">prepare</A></CODE> in interface <CODE><A HREF="../../../backtype/storm/task/IBolt.html" title="interface in backtype.storm.task">IBolt</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conf</CODE> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.<DD><CODE>context</CODE> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.<DD><CODE>collector</CODE> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is not thread-safe and should be saved as an instance variable of this bolt object.</DL>
<DT><B>Parameters:</B><DD><CODE>conf</CODE> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.<DD><CODE>context</CODE> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.<DD><CODE>collector</CODE> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(backtype.storm.tuple.Tuple)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="class in backtype.storm.tuple">Tuple</A>&nbsp;input)</PRE>
public void <B>execute</B>(<A HREF="../../../backtype/storm/tuple/Tuple.html" title="interface in backtype.storm.tuple">Tuple</A>&nbsp;input)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../backtype/storm/task/IBolt.html#execute(backtype.storm.tuple.Tuple)">IBolt</A></CODE></B></DD>
<DD>Process a single tuple of input. The Tuple object contains metadata on it
Expand Down
23 changes: 21 additions & 2 deletions doc/backtype/storm/coordination/BatchOutputCollector.html
View file
Expand Up @@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
<!-- Generated by javadoc (build 1.6.0_33) on Thu Aug 02 09:25:46 PDT 2012 -->
<TITLE>
BatchOutputCollector
</TITLE>

<META NAME="date" CONTENT="2012-04-02">
<META NAME="date" CONTENT="2012-08-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

Expand Down Expand Up @@ -164,6 +164,14 @@ <H2>
java.lang.String&nbsp;streamId,
java.util.List&lt;java.lang.Object&gt;&nbsp;tuple)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../backtype/storm/coordination/BatchOutputCollector.html#reportError(java.lang.Throwable)">reportError</A></B>(java.lang.Throwable&nbsp;error)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
Expand Down Expand Up @@ -259,6 +267,17 @@ <H2>
</DL>
</DD>
</DL>
<HR>

<A NAME="reportError(java.lang.Throwable)"><!-- --></A><H3>
reportError</H3>
<PRE>
public abstract void <B>reportError</B>(java.lang.Throwable&nbsp;error)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

Expand Down

0 comments on commit f00db2f

Please sign in to comment.