Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / 2.6.2 / javadocs / org / apache / storm / state / StateEncoder.html
blob: af6f06cb4b6ed1f4db9b32f39a31dde04c9fe168 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>StateEncoder (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.storm.state, interface: StateEncoder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.state</a></div>
<h1 title="Interface StateEncoder" class="title">Interface StateEncoder&lt;K,<wbr>V,<wbr>KENCODEDT,<wbr>VENCODEDT&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DefaultStateEncoder.html" title="class in org.apache.storm.state">DefaultStateEncoder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StateEncoder&lt;K,<wbr>V,<wbr>KENCODEDT,<wbr>VENCODEDT&gt;</span></div>
<div class="block">The interface of State Encoder.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateEncoder.html" title="type parameter in StateEncoder">K</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decodeKey(KENCODEDT)" class="member-name-link">decodeKey</a><wbr>(<a href="StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a>&nbsp;encodedKey)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Decode key.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateEncoder.html" title="type parameter in StateEncoder">V</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decodeValue(VENCODEDT)" class="member-name-link">decodeValue</a><wbr>(<a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;encodedValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Decode value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#encodeKey(K)" class="member-name-link">encodeKey</a><wbr>(<a href="StateEncoder.html" title="type parameter in StateEncoder">K</a>&nbsp;key)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Encode key.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#encodeValue(V)" class="member-name-link">encodeValue</a><wbr>(<a href="StateEncoder.html" title="type parameter in StateEncoder">V</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Encode value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTombstoneValue()" class="member-name-link">getTombstoneValue</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the tombstone value (deletion mark).</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="encodeKey(K)">
<h3 id="encodeKey(java.lang.Object)">encodeKey</h3>
<div class="member-signature"><span class="return-type"><a href="StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a></span>&nbsp;<span class="element-name">encodeKey</span><wbr><span class="parameters">(<a href="StateEncoder.html" title="type parameter in StateEncoder">K</a>&nbsp;key)</span></div>
<div class="block">Encode key.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the value of key (K type)</dd>
<dt>Returns:</dt>
<dd>the encoded value of key (KENCODEDT type)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="encodeValue(V)">
<h3 id="encodeValue(java.lang.Object)">encodeValue</h3>
<div class="member-signature"><span class="return-type"><a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></span>&nbsp;<span class="element-name">encodeValue</span><wbr><span class="parameters">(<a href="StateEncoder.html" title="type parameter in StateEncoder">V</a>&nbsp;value)</span></div>
<div class="block">Encode value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - the value of value (V type)</dd>
<dt>Returns:</dt>
<dd>the encoded value of value (VENCODEDT type)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decodeKey(KENCODEDT)">
<h3 id="decodeKey(java.lang.Object)">decodeKey</h3>
<div class="member-signature"><span class="return-type"><a href="StateEncoder.html" title="type parameter in StateEncoder">K</a></span>&nbsp;<span class="element-name">decodeKey</span><wbr><span class="parameters">(<a href="StateEncoder.html" title="type parameter in StateEncoder">KENCODEDT</a>&nbsp;encodedKey)</span></div>
<div class="block">Decode key.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>encodedKey</code> - the value of key (KRAW type)</dd>
<dt>Returns:</dt>
<dd>the decoded value of key (K type)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decodeValue(VENCODEDT)">
<h3 id="decodeValue(java.lang.Object)">decodeValue</h3>
<div class="member-signature"><span class="return-type"><a href="StateEncoder.html" title="type parameter in StateEncoder">V</a></span>&nbsp;<span class="element-name">decodeValue</span><wbr><span class="parameters">(<a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a>&nbsp;encodedValue)</span></div>
<div class="block">Decode value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>encodedValue</code> - the value of key (VENCODEDT type)</dd>
<dt>Returns:</dt>
<dd>the decoded value of key (V type)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTombstoneValue()">
<h3>getTombstoneValue</h3>
<div class="member-signature"><span class="return-type"><a href="StateEncoder.html" title="type parameter in StateEncoder">VENCODEDT</a></span>&nbsp;<span class="element-name">getTombstoneValue</span>()</div>
<div class="block">Get the tombstone value (deletion mark).</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the tomestone value (VENCODEDT type)</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>