| <!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.7.0_80) on Thu Aug 04 13:19:28 BST 2016 --> |
| <title>ValueTransformer (kafka 0.10.0.1 API)</title> |
| <meta name="date" content="2016-08-04"> |
| <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="ValueTransformer (kafka 0.10.0.1 API)"; |
| } |
| //--> |
| </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="../../../../../org/apache/kafka/streams/kstream/ValueMapper.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/ValueTransformer.html" target="_top">Frames</a></li> |
| <li><a href="ValueTransformer.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>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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.kafka.streams.kstream</div> |
| <h2 title="Interface ValueTransformer" class="title">Interface ValueTransformer<V,R></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>V</code> - value type</dd><dd><code>R</code> - return type</dd></dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ValueTransformer<V,R></span></pre> |
| <div class="block">A stateful <a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="interface in org.apache.kafka.streams.kstream"><code>ValueTransformer</code></a> interface to transform a value into a new value.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#close()">close</a></strong>()</code> |
| <div class="block">Close this processor and clean up any resources.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)">init</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</code> |
| <div class="block">Initialize this transformer with the given context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">R</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#punctuate(long)">punctuate</a></strong>(long timestamp)</code> |
| <div class="block">Perform any periodic operations and possibly return a new value, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context |
| during <a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">R</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#transform(V)">transform</a></strong>(<a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">V</a> value)</code> |
| <div class="block">Transform the record with the given key and value.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="init(org.apache.kafka.streams.processor.ProcessorContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>void init(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</pre> |
| <div class="block">Initialize this transformer with the given context. The framework ensures this is called once per processor when the topology |
| that contains it is initialized. |
| <p> |
| If this transformer is to be <a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#punctuate(long)"><code>called periodically</code></a> by the framework, then this method should |
| <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the provided context.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the context; may not be null</dd></dl> |
| </li> |
| </ul> |
| <a name="transform(java.lang.Object)"> |
| <!-- --> |
| </a><a name="transform(V)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">R</a> transform(<a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">V</a> value)</pre> |
| <div class="block">Transform the record with the given key and value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value for the record</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>new value</dd></dl> |
| </li> |
| </ul> |
| <a name="punctuate(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>punctuate</h4> |
| <pre><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html" title="type parameter in ValueTransformer">R</a> punctuate(long timestamp)</pre> |
| <div class="block">Perform any periodic operations and possibly return a new value, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context |
| during <a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - the stream time when this method is being called</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>new value; if null it will not be forwarded to down stream</dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Close this processor and clean up any resources.</div> |
| </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="../../../../../org/apache/kafka/streams/kstream/ValueMapper.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/streams/kstream/ValueTransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/ValueTransformer.html" target="_top">Frames</a></li> |
| <li><a href="ValueTransformer.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>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 ======= --> |
| </body> |
| </html> |
