| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.6.0_36) on Tue Dec 29 00:09:29 CST 2015 --> |
| <title>Processor.DefaultProcessor</title> |
| <meta name="date" content="2015-12-29"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Processor.DefaultProcessor"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor$.html" title="class in io.gearpump.streaming"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?io/gearpump/streaming/Processor.DefaultProcessor.html" target="_top">FRAMES</a></li> |
| <li><a href="Processor.DefaultProcessor.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) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_summary">CONSTR</a> | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_detail">CONSTR</a> | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <p class="subTitle">io.gearpump.streaming</p> |
| <h2 title="Class Processor.DefaultProcessor" class="title">Class Processor.DefaultProcessor<T extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.gearpump.streaming.Processor.DefaultProcessor<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><T>, io.gearpump.util.ReferenceEqual, java.io.Serializable, scala.Equals, scala.Product</dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><<a href="../../../io/gearpump/streaming/Processor.html" title="type parameter in Processor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <strong>Processor.DefaultProcessor<T extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></strong> |
| extends java.lang.Object |
| implements <a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><T>, scala.Product, scala.Serializable</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#io.gearpump.streaming.Processor.DefaultProcessor">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_io.gearpump.streaming.Processor"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface io.gearpump.streaming.<a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a></h3> |
| <code><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>>, <a href="../../../io/gearpump/streaming/Processor.DefaultProcessor$.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor$</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#Processor.DefaultProcessor(int, java.lang.String, io.gearpump.cluster.UserConfig, java.lang.Class)">Processor.DefaultProcessor</a></strong>(int parallelism, |
| java.lang.String description, |
| io.gearpump.cluster.UserConfig taskConf, |
| java.lang.Class<<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> taskClass)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#description()">description</a></strong>()</code> |
| <div class="block">Some description text for this processor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#parallelism()">parallelism</a></strong>()</code> |
| <div class="block">How many tasks you want to use for this processor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#taskClass()">taskClass</a></strong>()</code> |
| <div class="block">The task class, should be a subtype of Task.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>io.gearpump.cluster.UserConfig</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#taskConf()">taskConf</a></strong>()</code> |
| <div class="block">The custom <code>UserConfig</code>, it is used to initialize a task in runtime.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#withConfig(io.gearpump.cluster.UserConfig)">withConfig</a></strong>(io.gearpump.cluster.UserConfig conf)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#withDescription(java.lang.String)">withDescription</a></strong>(java.lang.String desc)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html#withParallelism(int)">withParallelism</a></strong>(int parallel)</code> </td> |
| </tr> |
| </table> |
| <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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_io.gearpump.util.ReferenceEqual"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface io.gearpump.util.ReferenceEqual</h3> |
| <code>equals</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_scala.Product"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface scala.Product</h3> |
| <code>productArity, productElement, productIterator, productPrefix</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_scala.Equals"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface scala.Equals</h3> |
| <code>canEqual, equals</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Processor.DefaultProcessor(int, java.lang.String, io.gearpump.cluster.UserConfig, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Processor.DefaultProcessor</h4> |
| <pre>public Processor.DefaultProcessor(int parallelism, |
| java.lang.String description, |
| io.gearpump.cluster.UserConfig taskConf, |
| java.lang.Class<<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> taskClass)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parallelism()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parallelism</h4> |
| <pre>public int parallelism()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../io/gearpump/streaming/Processor.html#parallelism()">Processor</a></code></strong></div> |
| <div class="block">How many tasks you want to use for this processor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../io/gearpump/streaming/Processor.html#parallelism()">parallelism</a></code> in interface <code><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="description()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre>public java.lang.String description()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../io/gearpump/streaming/Processor.html#description()">Processor</a></code></strong></div> |
| <div class="block">Some description text for this processor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../io/gearpump/streaming/Processor.html#description()">description</a></code> in interface <code><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="taskConf()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskConf</h4> |
| <pre>public io.gearpump.cluster.UserConfig taskConf()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../io/gearpump/streaming/Processor.html#taskConf()">Processor</a></code></strong></div> |
| <div class="block">The custom <code>UserConfig</code>, it is used to initialize a task in runtime.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../io/gearpump/streaming/Processor.html#taskConf()">taskConf</a></code> in interface <code><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="taskClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskClass</h4> |
| <pre>public java.lang.Class<<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> taskClass()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../io/gearpump/streaming/Processor.html#taskClass()">Processor</a></code></strong></div> |
| <div class="block">The task class, should be a subtype of Task. |
| <p> |
| Each runtime instance of this class is a task.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../io/gearpump/streaming/Processor.html#taskClass()">taskClass</a></code> in interface <code><a href="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming">Processor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="withParallelism(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withParallelism</h4> |
| <pre>public <a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> withParallelism(int parallel)</pre> |
| </li> |
| </ul> |
| <a name="withDescription(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDescription</h4> |
| <pre>public <a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> withDescription(java.lang.String desc)</pre> |
| </li> |
| </ul> |
| <a name="withConfig(io.gearpump.cluster.UserConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>withConfig</h4> |
| <pre>public <a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a>> withConfig(io.gearpump.cluster.UserConfig conf)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../io/gearpump/streaming/Processor.html" title="interface in io.gearpump.streaming"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor$.html" title="class in io.gearpump.streaming"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?io/gearpump/streaming/Processor.DefaultProcessor.html" target="_top">FRAMES</a></li> |
| <li><a href="Processor.DefaultProcessor.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) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_summary">CONSTR</a> | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_detail">CONSTR</a> | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |