Permalink
Browse files

update javadoc

  • Loading branch information...
1 parent 701a173 commit c76c95943f1c9ee668c9768fe7c7fd8eec54137b @nathanmarz nathanmarz committed Oct 2, 2011
Showing with 982 additions and 336 deletions.
  1. +4 −2 doc/allclasses-frame.html
  2. +4 −2 doc/allclasses-noframe.html
  3. +29 −4 doc/backtype/storm/Config.html
  4. +2 −2 doc/backtype/storm/Constants.html
  5. +2 −2 doc/backtype/storm/ILocalCluster.html
  6. +2 −2 doc/backtype/storm/StormSubmitter.html
  7. +6 −24 doc/backtype/storm/clojure/ClojureBolt.html
  8. +445 −0 doc/backtype/storm/clojure/ClojureSpout.html
  9. +5 −3 doc/backtype/storm/clojure/package-frame.html
  10. +6 −2 doc/backtype/storm/clojure/package-summary.html
  11. +3 −2 doc/backtype/storm/clojure/package-tree.html
  12. +2 −2 doc/backtype/storm/daemon/Shutdownable.html
  13. +2 −2 doc/backtype/storm/daemon/package-frame.html
  14. +2 −2 doc/backtype/storm/daemon/package-summary.html
  15. +2 −2 doc/backtype/storm/daemon/package-tree.html
  16. +2 −2 doc/backtype/storm/drpc/DRPCScheme.html
  17. +2 −2 doc/backtype/storm/drpc/ReturnResults.html
  18. +2 −2 doc/backtype/storm/drpc/SpoutAdder.html
  19. +2 −2 doc/backtype/storm/drpc/package-frame.html
  20. +2 −2 doc/backtype/storm/drpc/package-summary.html
  21. +2 −2 doc/backtype/storm/drpc/package-tree.html
  22. +2 −2 doc/backtype/storm/package-frame.html
  23. +2 −2 doc/backtype/storm/package-summary.html
  24. +2 −2 doc/backtype/storm/package-tree.html
  25. +2 −2 doc/backtype/storm/planner/CompoundSpout.html
  26. +2 −2 doc/backtype/storm/planner/CompoundTask.html
  27. +2 −2 doc/backtype/storm/planner/TaskBundle.html
  28. +2 −2 doc/backtype/storm/planner/package-frame.html
  29. +2 −2 doc/backtype/storm/planner/package-summary.html
  30. +2 −2 doc/backtype/storm/planner/package-tree.html
  31. +2 −2 doc/backtype/storm/serialization/FieldSerialization.html
  32. +2 −2 doc/backtype/storm/serialization/ISerialization.html
  33. +2 −2 doc/backtype/storm/serialization/SerializationFactory.html
  34. +2 −2 doc/backtype/storm/serialization/TupleDeserializer.html
  35. +2 −2 doc/backtype/storm/serialization/TupleSerializer.html
  36. +2 −2 doc/backtype/storm/serialization/ValuesDeserializer.html
  37. +2 −2 doc/backtype/storm/serialization/ValuesSerializer.html
  38. +2 −2 doc/backtype/storm/serialization/package-frame.html
  39. +2 −2 doc/backtype/storm/serialization/package-summary.html
  40. +2 −2 doc/backtype/storm/serialization/package-tree.html
  41. +12 −9 doc/backtype/storm/spout/ISpout.html
  42. +2 −2 doc/backtype/storm/spout/ISpoutOutputCollector.html
  43. +2 −2 doc/backtype/storm/spout/RawScheme.html
  44. +2 −2 doc/backtype/storm/spout/Scheme.html
  45. +22 −4 doc/backtype/storm/spout/ShellSpout.html
  46. +2 −2 doc/backtype/storm/spout/SpoutOutputCollector.html
  47. +2 −2 doc/backtype/storm/spout/package-frame.html
  48. +2 −2 doc/backtype/storm/spout/package-summary.html
  49. +2 −2 doc/backtype/storm/spout/package-tree.html
  50. +2 −2 doc/backtype/storm/state/IStateSpout.html
  51. +2 −2 doc/backtype/storm/state/IStateSpoutOutputCollector.html
  52. +2 −2 doc/backtype/storm/state/ISubscribedState.html
  53. +2 −2 doc/backtype/storm/state/ISynchronizeOutputCollector.html
  54. +2 −2 doc/backtype/storm/state/StateSpoutOutputCollector.html
  55. +2 −2 doc/backtype/storm/state/SynchronizeOutputCollector.html
  56. +2 −2 doc/backtype/storm/state/package-frame.html
  57. +2 −2 doc/backtype/storm/state/package-summary.html
  58. +2 −2 doc/backtype/storm/state/package-tree.html
  59. +2 −2 doc/backtype/storm/task/CoordinatedBolt.CoordinatedOutputCollector.html
  60. +2 −2 doc/backtype/storm/task/CoordinatedBolt.FinishedCallback.html
  61. +2 −2 doc/backtype/storm/task/CoordinatedBolt.SourceArgs.html
  62. +2 −2 doc/backtype/storm/task/CoordinatedBolt.TrackingInfo.html
  63. +2 −2 doc/backtype/storm/task/CoordinatedBolt.html
  64. +2 −2 doc/backtype/storm/task/IBolt.html
  65. +2 −2 doc/backtype/storm/task/IInternalOutputCollector.html
  66. +2 −2 doc/backtype/storm/task/IOutputCollector.html
  67. +2 −2 doc/backtype/storm/task/KeyedFairBolt.html
  68. +2 −2 doc/backtype/storm/task/OutputCollector.html
  69. +2 −2 doc/backtype/storm/task/OutputCollectorImpl.html
  70. +2 −2 doc/backtype/storm/task/ShellBolt.html
  71. +2 −2 doc/backtype/storm/task/TopologyContext.html
  72. +2 −2 doc/backtype/storm/task/package-frame.html
  73. +2 −2 doc/backtype/storm/task/package-summary.html
  74. +2 −2 doc/backtype/storm/task/package-tree.html
  75. +2 −2 doc/backtype/storm/testing/AckFailDelegate.html
  76. +2 −2 doc/backtype/storm/testing/AckTracker.html
  77. +2 −2 doc/backtype/storm/testing/BoltTracker.html
  78. +6 −4 doc/backtype/storm/testing/FeederSpout.html
  79. +2 −2 doc/backtype/storm/testing/FixedTuple.html
  80. +6 −4 doc/backtype/storm/testing/FixedTupleSpout.html
  81. +6 −4 doc/backtype/storm/testing/SpoutTracker.html
  82. +2 −2 doc/backtype/storm/testing/TestAggregatesCounter.html
  83. +2 −2 doc/backtype/storm/testing/TestGlobalCount.html
  84. +2 −2 doc/backtype/storm/testing/TestPlannerBolt.html
  85. +6 −4 doc/backtype/storm/testing/TestPlannerSpout.html
  86. +2 −2 doc/backtype/storm/testing/TestWordCounter.html
  87. +6 −4 doc/backtype/storm/testing/TestWordSpout.html
  88. +2 −2 doc/backtype/storm/testing/TrackerAggregator.TrackStats.html
  89. +2 −2 doc/backtype/storm/testing/TrackerAggregator.html
  90. +2 −2 doc/backtype/storm/testing/TupleCaptureBolt.html
  91. +2 −2 doc/backtype/storm/testing/package-frame.html
  92. +2 −2 doc/backtype/storm/testing/package-summary.html
  93. +2 −2 doc/backtype/storm/testing/package-tree.html
  94. +2 −2 doc/backtype/storm/topology/BasicBoltExecutor.html
  95. +2 −2 doc/backtype/storm/topology/BasicOutputCollector.html
  96. +2 −2 doc/backtype/storm/topology/IBasicBolt.html
  97. +2 −2 doc/backtype/storm/topology/IBasicOutputCollector.html
  98. +3 −3 doc/backtype/storm/topology/IComponent.html
  99. +2 −2 doc/backtype/storm/topology/IRichBolt.html
  100. +3 −3 doc/backtype/storm/topology/IRichSpout.html
  101. +2 −2 doc/backtype/storm/topology/IRichStateSpout.html
  102. +2 −2 doc/backtype/storm/topology/InputDeclarer.html
  103. +2 −2 doc/backtype/storm/topology/OutputFieldsDeclarer.html
  104. +2 −2 doc/backtype/storm/topology/OutputFieldsGetter.html
  105. +2 −2 doc/backtype/storm/topology/TopologyBuilder.InputGetter.html
  106. +2 −2 doc/backtype/storm/topology/TopologyBuilder.html
  107. +2 −2 doc/backtype/storm/topology/package-frame.html
  108. +2 −2 doc/backtype/storm/topology/package-summary.html
  109. +2 −2 doc/backtype/storm/topology/package-tree.html
  110. +2 −2 doc/backtype/storm/tuple/Fields.html
  111. +2 −2 doc/backtype/storm/tuple/MessageId.html
  112. +42 −2 doc/backtype/storm/tuple/Tuple.html
  113. +2 −2 doc/backtype/storm/tuple/Values.html
  114. +2 −2 doc/backtype/storm/tuple/package-frame.html
  115. +2 −2 doc/backtype/storm/tuple/package-summary.html
  116. +2 −2 doc/backtype/storm/tuple/package-tree.html
  117. +2 −2 doc/backtype/storm/utils/BufferFileInputStream.html
  118. +2 −2 doc/backtype/storm/utils/CRC32OutputStream.html
  119. +2 −2 doc/backtype/storm/utils/DRPCClient.html
  120. +2 −2 doc/backtype/storm/utils/KeyedRoundRobinQueue.html
  121. +2 −2 doc/backtype/storm/utils/LocalState.html
  122. +2 −2 doc/backtype/storm/utils/NimbusClient.html
  123. +2 −2 doc/backtype/storm/utils/Time.html
  124. +2 −2 doc/backtype/storm/utils/TimeCacheMap.ExpiredCallback.html
  125. +2 −2 doc/backtype/storm/utils/TimeCacheMap.html
  126. +23 −2 doc/backtype/storm/utils/Utils.html
  127. +2 −2 doc/backtype/storm/utils/VersionedStore.html
  128. +2 −2 doc/backtype/storm/utils/WritableUtils.html
  129. +2 −2 doc/backtype/storm/utils/package-frame.html
  130. +2 −2 doc/backtype/storm/utils/package-summary.html
  131. +2 −2 doc/backtype/storm/utils/package-tree.html
  132. +2 −2 doc/constant-values.html
  133. +2 −2 doc/deprecated-list.html
  134. +2 −2 doc/help-doc.html
  135. +43 −7 doc/index-all.html
  136. +1 −1 doc/index.html
  137. +2 −2 doc/overview-frame.html
  138. +2 −2 doc/overview-summary.html
  139. +3 −2 doc/overview-tree.html
  140. +64 −10 doc/serialized-form.html
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:57 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:36 PDT 2011 -->
<TITLE>
All Classes
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -35,6 +35,8 @@
<BR>
<A HREF="backtype/storm/clojure/ClojureBolt.html" title="class in backtype.storm.clojure" target="classFrame">ClojureBolt</A>
<BR>
+<A HREF="backtype/storm/clojure/ClojureSpout.html" title="class in backtype.storm.clojure" target="classFrame">ClojureSpout</A>
+<BR>
<A HREF="backtype/storm/planner/CompoundSpout.html" title="class in backtype.storm.planner" target="classFrame">CompoundSpout</A>
<BR>
<A HREF="backtype/storm/planner/CompoundTask.html" title="class in backtype.storm.planner" target="classFrame">CompoundTask</A>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:57 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:36 PDT 2011 -->
<TITLE>
All Classes
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -35,6 +35,8 @@
<BR>
<A HREF="backtype/storm/clojure/ClojureBolt.html" title="class in backtype.storm.clojure">ClojureBolt</A>
<BR>
+<A HREF="backtype/storm/clojure/ClojureSpout.html" title="class in backtype.storm.clojure">ClojureSpout</A>
+<BR>
<A HREF="backtype/storm/planner/CompoundSpout.html" title="class in backtype.storm.planner">CompoundSpout</A>
<BR>
<A HREF="backtype/storm/planner/CompoundTask.html" title="class in backtype.storm.planner">CompoundTask</A>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:54 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:35 PDT 2011 -->
<TITLE>
Config
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -266,6 +266,14 @@
<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/Config.html#STORM_LOCAL_MODE_ZMQ">STORM_LOCAL_MODE_ZMQ</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether or not to use ZeroMQ for messaging in local mode.</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/Config.html#STORM_ZOOKEEPER_PORT">STORM_ZOOKEEPER_PORT</A></B></CODE>
<BR>
@@ -528,7 +536,7 @@
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#addSerialization(int, java.lang.Class)">addSerialization</A></B>(int&nbsp;token,
- java.lang.Class&lt;<A HREF="../../backtype/storm/serialization/ISerialization.html" title="interface in backtype.storm.serialization">ISerialization</A>&gt;&nbsp;serialization)</CODE>
+ java.lang.Class&lt;? extends <A HREF="../../backtype/storm/serialization/ISerialization.html" title="interface in backtype.storm.serialization">ISerialization</A>&gt;&nbsp;serialization)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
@@ -705,6 +713,23 @@
</DL>
<HR>
+<A NAME="STORM_LOCAL_MODE_ZMQ"><!-- --></A><H3>
+STORM_LOCAL_MODE_ZMQ</H3>
+<PRE>
+public static java.lang.String <B>STORM_LOCAL_MODE_ZMQ</B></PRE>
+<DL>
+<DD>Whether or not to use ZeroMQ for messaging in local mode. If this is set
+ to false, then Storm will use a pure-Java messaging system. The purpose
+ of this flag is to make it easy to run Storm in local mode by eliminating
+ the need for native dependencies, which can be difficult to install.
+
+ Defaults to false.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
<A NAME="STORM_ZOOKEEPER_ROOT"><!-- --></A><H3>
STORM_ZOOKEEPER_ROOT</H3>
<PRE>
@@ -1297,7 +1322,7 @@
addSerialization</H3>
<PRE>
public void <B>addSerialization</B>(int&nbsp;token,
- java.lang.Class&lt;<A HREF="../../backtype/storm/serialization/ISerialization.html" title="interface in backtype.storm.serialization">ISerialization</A>&gt;&nbsp;serialization)</PRE>
+ java.lang.Class&lt;? extends <A HREF="../../backtype/storm/serialization/ISerialization.html" title="interface in backtype.storm.serialization">ISerialization</A>&gt;&nbsp;serialization)</PRE>
<DL>
<DD><DL>
</DL>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:54 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:35 PDT 2011 -->
<TITLE>
Constants
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:54 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:35 PDT 2011 -->
<TITLE>
ILocalCluster
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:54 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:35 PDT 2011 -->
<TITLE>
StormSubmitter
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_26) on Wed Sep 21 19:47:55 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_26) on Sat Oct 01 21:40:36 PDT 2011 -->
<TITLE>
ClojureBolt
</TITLE>
-<META NAME="date" CONTENT="2011-09-21">
+<META NAME="date" CONTENT="2011-10-01">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -55,7 +55,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
-&nbsp;NEXT CLASS</FONT></TD>
+&nbsp;<A HREF="../../../backtype/storm/clojure/ClojureSpout.html" title="class in backtype.storm.clojure"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?backtype/storm/clojure/ClojureBolt.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ClojureBolt.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
@@ -120,15 +120,7 @@
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../backtype/storm/clojure/ClojureBolt.html#ClojureBolt(java.lang.String, java.lang.String, java.util.List, java.util.Map)">ClojureBolt</A></B>(java.lang.String&nbsp;namespace,
java.lang.String&nbsp;fnName,
- java.util.List&lt;java.lang.Object&gt;&nbsp;args,
- java.util.Map&lt;java.lang.Integer,StreamInfo&gt;&nbsp;fields)</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../backtype/storm/clojure/ClojureBolt.html#ClojureBolt(java.lang.String, java.lang.String, java.util.Map)">ClojureBolt</A></B>(java.lang.String&nbsp;namespace,
- java.lang.String&nbsp;fnName,
+ java.util.List&lt;java.lang.Object&gt;&nbsp;params,
java.util.Map&lt;java.lang.Integer,StreamInfo&gt;&nbsp;fields)</CODE>
<BR>
@@ -201,22 +193,12 @@
</TR>
</TABLE>
-<A NAME="ClojureBolt(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
-ClojureBolt</H3>
-<PRE>
-public <B>ClojureBolt</B>(java.lang.String&nbsp;namespace,
- java.lang.String&nbsp;fnName,
- java.util.Map&lt;java.lang.Integer,StreamInfo&gt;&nbsp;fields)</PRE>
-<DL>
-</DL>
-<HR>
-
<A NAME="ClojureBolt(java.lang.String, java.lang.String, java.util.List, java.util.Map)"><!-- --></A><H3>
ClojureBolt</H3>
<PRE>
public <B>ClojureBolt</B>(java.lang.String&nbsp;namespace,
java.lang.String&nbsp;fnName,
- java.util.List&lt;java.lang.Object&gt;&nbsp;args,
+ java.util.List&lt;java.lang.Object&gt;&nbsp;params,
java.util.Map&lt;java.lang.Integer,StreamInfo&gt;&nbsp;fields)</PRE>
<DL>
</DL>
@@ -349,7 +331,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
-&nbsp;NEXT CLASS</FONT></TD>
+&nbsp;<A HREF="../../../backtype/storm/clojure/ClojureSpout.html" title="class in backtype.storm.clojure"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?backtype/storm/clojure/ClojureBolt.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ClojureBolt.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
Oops, something went wrong.

0 comments on commit c76c959

Please sign in to comment.