blob: 5cb859382c0e2b986a4cac32ef5dfcf4fef69847 [file] [log] [blame]
<!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 (1.8.0_121) on Sun Jul 09 07:41:23 CEST 2017 -->
<title>Processor</title>
<meta name="date" content="2017-07-09">
<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="Processor";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</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/gearpump/streaming/javaapi/Graph.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/javaapi/StreamApplication.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/javaapi/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">
<div class="subTitle">org.apache.gearpump.streaming.javaapi</div>
<h2 title="Class Processor" class="title">Class Processor&lt;T extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.gearpump.streaming.javaapi.Processor&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;T&gt;, <a href="../../../../../org/apache/gearpump/util/ReferenceEqual.html" title="interface in org.apache.gearpump.util">ReferenceEqual</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Processor&lt;T extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;T&gt;</pre>
<div class="block">Java version of Processor
See <a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming"><code>Processor</code></a></div>
</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.org.apache.gearpump.streaming.Processor">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.gearpump.streaming.<a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a></h3>
<code><a href="../../../../../org/apache/gearpump/streaming/Processor.DefaultProcessor.html" title="class in org.apache.gearpump.streaming">Processor.DefaultProcessor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;, <a href="../../../../../org/apache/gearpump/streaming/Processor.DefaultProcessor$.html" title="class in org.apache.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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#Processor-java.lang.Class-">Processor</a></span>(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#Processor-java.lang.Class-int-">Processor</a></span>(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass,
int&nbsp;parallelism)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#Processor-java.lang.Class-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-">Processor</a></span>(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf)</code>
<div class="block">Creates a general processor with user specified task logic.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#Processor-org.apache.gearpump.streaming.Processor-">Processor</a></span>(<a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;processor)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#description--">description</a></span>()</code>
<div class="block">Some description text for this processor.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
<div class="block">reference equal</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#parallelism--">parallelism</a></span>()</code>
<div class="block">How many tasks you want to use for this processor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/sink/DataSinkTask.html" title="class in org.apache.gearpump.streaming.sink">DataSinkTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#sink-org.apache.gearpump.streaming.sink.DataSink-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-akka.actor.ActorSystem-">sink</a></span>(<a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html" title="interface in org.apache.gearpump.streaming.sink">DataSink</a>&nbsp;dataSink,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf,
akka.actor.ActorSystem&nbsp;system)</code>
<div class="block">Creates a Sink Processor</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source">DataSourceTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#source-org.apache.gearpump.streaming.source.DataSource-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-akka.actor.ActorSystem-">source</a></span>(<a href="../../../../../org/apache/gearpump/streaming/source/DataSource.html" title="interface in org.apache.gearpump.streaming.source">DataSource</a>&nbsp;source,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf,
akka.actor.ActorSystem&nbsp;system)</code>
<div class="block">Creates a Source Processor</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#taskClass--">taskClass</a></span>()</code>
<div class="block">The task class, should be a subtype of Task.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#taskConf--">taskConf</a></span>()</code>
<div class="block">The custom <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster"><code>UserConfig</code></a>, it is used to
initialize a task in runtime.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#withConfig-org.apache.gearpump.cluster.UserConfig-">withConfig</a></span>(<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#withDescription-java.lang.String-">withDescription</a></span>(java.lang.String&nbsp;desc)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html#withParallelism-int-">withParallelism</a></span>(int&nbsp;parallel)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.gearpump.util.ReferenceEqual">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.gearpump.util.<a href="../../../../../org/apache/gearpump/util/ReferenceEqual.html" title="interface in org.apache.gearpump.util">ReferenceEqual</a></h3>
<code><a href="../../../../../org/apache/gearpump/util/ReferenceEqual.html#hashCode--">hashCode</a></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-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Processor</h4>
<pre>public&nbsp;Processor(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass)</pre>
</li>
</ul>
<a name="Processor-java.lang.Class-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Processor</h4>
<pre>public&nbsp;Processor(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass,
int&nbsp;parallelism)</pre>
</li>
</ul>
<a name="Processor-org.apache.gearpump.streaming.Processor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Processor</h4>
<pre>public&nbsp;Processor(<a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;processor)</pre>
</li>
</ul>
<a name="Processor-java.lang.Class-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Processor</h4>
<pre>public&nbsp;Processor(java.lang.Class&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;taskClass,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf)</pre>
<div class="block">Creates a general processor with user specified task logic.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskClass</code> - task implementation class of this processor (shall be a derived class from <a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html" title="class in org.apache.gearpump.streaming.javaapi"><code>Task</code></a></dd>
<dd><code>parallelism,</code> - how many initial tasks you want to use</dd>
<dd><code>description,</code> - some text to describe this processor</dd>
<dd><code>taskConf,</code> - Processor specific configuration</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sink-org.apache.gearpump.streaming.sink.DataSink-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-akka.actor.ActorSystem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sink</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/sink/DataSinkTask.html" title="class in org.apache.gearpump.streaming.sink">DataSinkTask</a>&gt;&nbsp;sink(<a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html" title="interface in org.apache.gearpump.streaming.sink">DataSink</a>&nbsp;dataSink,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf,
akka.actor.ActorSystem&nbsp;system)</pre>
<div class="block">Creates a Sink Processor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataSink</code> - the data sink itself</dd>
<dd><code>parallelism</code> - the parallelism of this processor</dd>
<dd><code>description</code> - the description for this processor</dd>
<dd><code>taskConf</code> - the configuration for this processor</dd>
<dd><code>system</code> - actor system</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new created sink processor</dd>
</dl>
</li>
</ul>
<a name="source-org.apache.gearpump.streaming.source.DataSource-int-java.lang.String-org.apache.gearpump.cluster.UserConfig-akka.actor.ActorSystem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>source</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source">DataSourceTask</a>&gt;&nbsp;source(<a href="../../../../../org/apache/gearpump/streaming/source/DataSource.html" title="interface in org.apache.gearpump.streaming.source">DataSource</a>&nbsp;source,
int&nbsp;parallelism,
java.lang.String&nbsp;description,
<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf,
akka.actor.ActorSystem&nbsp;system)</pre>
<div class="block">Creates a Source Processor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the data source itself</dd>
<dd><code>parallelism</code> - the parallelism of this processor</dd>
<dd><code>description</code> - the description of this processor</dd>
<dd><code>taskConf</code> - the configuration of this processor</dd>
<dd><code>system</code> - actor system</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new created source processor</dd>
</dl>
</li>
</ul>
<a name="withParallelism-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withParallelism</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;withParallelism(int&nbsp;parallel)</pre>
</li>
</ul>
<a name="withDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDescription</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;withDescription(java.lang.String&nbsp;desc)</pre>
</li>
</ul>
<a name="withConfig-org.apache.gearpump.cluster.UserConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="class in org.apache.gearpump.streaming.javaapi">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a>&gt;&nbsp;withConfig(<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;conf)</pre>
</li>
</ul>
<a name="parallelism--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parallelism</h4>
<pre>public&nbsp;int&nbsp;parallelism()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#parallelism--">Processor</a></code></span></div>
<div class="block">How many tasks you want to use for this processor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#parallelism--">parallelism</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a> extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="taskConf--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>taskConf</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a>&nbsp;taskConf()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#taskConf--">Processor</a></code></span></div>
<div class="block">The custom <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster"><code>UserConfig</code></a>, it is used to
initialize a task in runtime.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#taskConf--">taskConf</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a> extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="description--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String&nbsp;description()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#description--">Processor</a></code></span></div>
<div class="block">Some description text for this processor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#description--">description</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a> extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="taskClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>taskClass</h4>
<pre>public&nbsp;java.lang.Class&lt;? extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;&nbsp;taskClass()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#taskClass--">Processor</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/gearpump/streaming/Processor.html#taskClass--">taskClass</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/gearpump/streaming/Processor.html" title="interface in org.apache.gearpump.streaming">Processor</a>&lt;<a href="../../../../../org/apache/gearpump/streaming/javaapi/Processor.html" title="type parameter in Processor">T</a> extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">reference equal</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/gearpump/util/ReferenceEqual.html#equals-java.lang.Object-">equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/gearpump/util/ReferenceEqual.html" title="interface in org.apache.gearpump.util">ReferenceEqual</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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/gearpump/streaming/javaapi/Graph.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/javaapi/StreamApplication.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/javaapi/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>