Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / state / StateEncoder.html
blob: 1a86481307a0ec677149bca35018b66a8f9c1aab [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StateEncoder (Storm 2.4.0 API)</title>
<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="StateEncoder (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/StateEncoder.html">Use</a></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/storm/state/State.html" title="interface in org.apache.storm.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/state/StateFactory.html" title="class in org.apache.storm.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/state/StateEncoder.html" target="_top">Frames</a></li>
<li><a href="StateEncoder.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>Constr&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>Constr&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.storm.state</div>
<h2 title="Interface StateEncoder" class="title">Interface StateEncoder&lt;K,V,KENCODEDT,VENCODEDT&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/storm/state/DefaultStateEncoder.html" title="class in org.apache.storm.state">DefaultStateEncoder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StateEncoder&lt;K,V,KENCODEDT,VENCODEDT&gt;</span></pre>
<div class="block"><p>The interface of State Encoder.</p></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="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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">K</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/state/StateEncoder.html#decodeKey-KENCODEDT-">decodeKey</a></span>(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a>&nbsp;encodedKey)</code>
<div class="block">Decode key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/state/StateEncoder.html#decodeValue-VENCODEDT-">decodeValue</a></span>(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;encodedValue)</code>
<div class="block">Decode value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/state/StateEncoder.html#encodeKey-K-">encodeKey</a></span>(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">K</a>&nbsp;key)</code>
<div class="block">Encode key.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/state/StateEncoder.html#encodeValue-V-">encodeValue</a></span>(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">V</a>&nbsp;value)</code>
<div class="block">Encode value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/state/StateEncoder.html#getTombstoneValue--">getTombstoneValue</a></span>()</code>
<div class="block">Get the tombstone value (deletion mark).</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="encodeKey-java.lang.Object-">
<!-- -->
</a><a name="encodeKey-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeKey</h4>
<pre><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a>&nbsp;encodeKey(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">K</a>&nbsp;key)</pre>
<div class="block"><p>Encode key.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the value of key (K type)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded value of key (KENCODEDT type)</dd>
</dl>
</li>
</ul>
<a name="encodeValue-java.lang.Object-">
<!-- -->
</a><a name="encodeValue-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeValue</h4>
<pre><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;encodeValue(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">V</a>&nbsp;value)</pre>
<div class="block"><p>Encode value.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value of value (V type)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded value of value (VENCODEDT type)</dd>
</dl>
</li>
</ul>
<a name="decodeKey-java.lang.Object-">
<!-- -->
</a><a name="decodeKey-KENCODEDT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeKey</h4>
<pre><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">K</a>&nbsp;decodeKey(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a>&nbsp;encodedKey)</pre>
<div class="block"><p>Decode key.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encodedKey</code> - the value of key (KRAW type)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the decoded value of key (K type)</dd>
</dl>
</li>
</ul>
<a name="decodeValue-java.lang.Object-">
<!-- -->
</a><a name="decodeValue-VENCODEDT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeValue</h4>
<pre><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">V</a>&nbsp;decodeValue(<a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;encodedValue)</pre>
<div class="block"><p>Decode value.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encodedValue</code> - the value of key (VENCODEDT type)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the decoded value of key (V type)</dd>
</dl>
</li>
</ul>
<a name="getTombstoneValue--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTombstoneValue</h4>
<pre><a href="../../../../org/apache/storm/state/StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;getTombstoneValue()</pre>
<div class="block"><p>Get the tombstone value (deletion mark).</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tomestone value (VENCODEDT type)</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="class-use/StateEncoder.html">Use</a></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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/state/StateFactory.html" title="class in org.apache.storm.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/state/StateEncoder.html" target="_top">Frames</a></li>
<li><a href="StateEncoder.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>