Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / current / javadocs / org / apache / storm / streams / operations / StateUpdater.html
blob: 4a130b2b3b8f3852a741a766b309706d12830a98 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>StateUpdater (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.streams.operations, interface: StateUpdater">
<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/StateUpdater.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.streams.operations</a></div>
<h1 title="Interface StateUpdater" class="title">Interface StateUpdater&lt;T,<wbr>S&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="Operation.html" title="interface in org.apache.storm.streams.operations">Operation</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StateUpdater&lt;T,<wbr>S&gt;</span><span class="extends-implements">
extends <a href="Operation.html" title="interface in org.apache.storm.streams.operations">Operation</a></span></div>
<div class="block">Interface for updating state.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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="StateUpdater.html" title="type parameter in StateUpdater">S</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#apply(S,T)" class="member-name-link">apply</a><wbr>(<a href="StateUpdater.html" title="type parameter in StateUpdater">S</a>&nbsp;state,
<a href="StateUpdater.html" title="type parameter in StateUpdater">T</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a new state by applying the value on the current state.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StateUpdater.html" title="type parameter in StateUpdater">S</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#init()" class="member-name-link">init</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The initial value of the state to start with.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static &lt;T,<wbr>
S&gt;&nbsp;<a href="StateUpdater.html" title="interface in org.apache.storm.streams.operations">StateUpdater</a>&lt;T,<wbr>S&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#of(S,org.apache.storm.streams.operations.BiFunction)" class="member-name-link">of</a><wbr>(S&nbsp;initialValue,
<a href="BiFunction.html" title="interface in org.apache.storm.streams.operations">BiFunction</a>&lt;? super S,<wbr>? super T,<wbr>? extends S&gt;&nbsp;stateUpdateFn)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
<div class="block">A static factory to create a <a href="StateUpdater.html" title="interface in org.apache.storm.streams.operations"><code>StateUpdater</code></a> based on an initial value of the state and a state update function.</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="of(S,org.apache.storm.streams.operations.BiFunction)">
<h3 id="of(java.lang.Object,org.apache.storm.streams.operations.BiFunction)">of</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="type-parameters">&lt;T,<wbr>
S&gt;</span>&nbsp;<span class="return-type"><a href="StateUpdater.html" title="interface in org.apache.storm.streams.operations">StateUpdater</a>&lt;T,<wbr>S&gt;</span>&nbsp;<span class="element-name">of</span><wbr><span class="parameters">(S&nbsp;initialValue,
<a href="BiFunction.html" title="interface in org.apache.storm.streams.operations">BiFunction</a>&lt;? super S,<wbr>? super T,<wbr>? extends S&gt;&nbsp;stateUpdateFn)</span></div>
<div class="block">A static factory to create a <a href="StateUpdater.html" title="interface in org.apache.storm.streams.operations"><code>StateUpdater</code></a> based on an initial value of the state and a state update function.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>initialValue</code> - the intial value of the state</dd>
<dd><code>stateUpdateFn</code> - the state update function</dd>
<dt>Returns:</dt>
<dd>the <a href="StateUpdater.html" title="interface in org.apache.storm.streams.operations"><code>StateUpdater</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="init()">
<h3>init</h3>
<div class="member-signature"><span class="return-type"><a href="StateUpdater.html" title="type parameter in StateUpdater">S</a></span>&nbsp;<span class="element-name">init</span>()</div>
<div class="block">The initial value of the state to start with.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the initial value of the state</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="apply(S,T)">
<h3 id="apply(java.lang.Object,java.lang.Object)">apply</h3>
<div class="member-signature"><span class="return-type"><a href="StateUpdater.html" title="type parameter in StateUpdater">S</a></span>&nbsp;<span class="element-name">apply</span><wbr><span class="parameters">(<a href="StateUpdater.html" title="type parameter in StateUpdater">S</a>&nbsp;state,
<a href="StateUpdater.html" title="type parameter in StateUpdater">T</a>&nbsp;value)</span></div>
<div class="block">Returns a new state by applying the value on the current state.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>state</code> - the current state</dd>
<dd><code>value</code> - the value</dd>
<dt>Returns:</dt>
<dd>the new state</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>