| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>KeyValueStore (kafka 3.6.1 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.kafka.streams.state, interface: KeyValueStore"> |
| <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.5.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="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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.kafka.streams.state</a></div> |
| <h1 title="Interface KeyValueStore" class="title">Interface KeyValueStore<K,<wbr>V></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type</dd> |
| <dd><code>V</code> - The value type</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlyKeyValueStore</a><K,<wbr>V></code>, <code><a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="TimestampedKeyValueStore.html" title="interface in org.apache.kafka.streams.state">TimestampedKeyValueStore</a><K,<wbr>V></code>, <code><a href="VersionedBytesStore.html" title="interface in org.apache.kafka.streams.state">VersionedBytesStore</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">KeyValueStore<K,<wbr>V></span><span class="extends-implements"> |
| extends <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>, <a href="ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlyKeyValueStore</a><K,<wbr>V></span></div> |
| <div class="block">A key-value store that supports put/get/delete and range queries.</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="KeyValueStore.html" title="type parameter in KeyValueStore">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#delete(K)" class="member-name-link">delete</a><wbr>(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Delete the value from the store (if there is one).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(K,V)" class="member-name-link">put</a><wbr>(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, |
| <a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the value associated with this key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putAll(java.util.List)" class="member-name-link">putAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../KeyValue.html" title="class in org.apache.kafka.streams">KeyValue</a><<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<wbr><a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a>>> entries)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update all the given key/value pairs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="KeyValueStore.html" title="type parameter in KeyValueStore">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="#putIfAbsent(K,V)" class="member-name-link">putIfAbsent</a><wbr>(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, |
| <a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the value associated with this key, unless a value is already associated with the key.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.streams.state.ReadOnlyKeyValueStore">Methods inherited from interface org.apache.kafka.streams.state.<a href="ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlyKeyValueStore</a></h3> |
| <code><a href="ReadOnlyKeyValueStore.html#all()">all</a>, <a href="ReadOnlyKeyValueStore.html#approximateNumEntries()">approximateNumEntries</a>, <a href="ReadOnlyKeyValueStore.html#get(K)">get</a>, <a href="ReadOnlyKeyValueStore.html#prefixScan(P,PS)">prefixScan</a>, <a href="ReadOnlyKeyValueStore.html#range(K,K)">range</a>, <a href="ReadOnlyKeyValueStore.html#reverseAll()">reverseAll</a>, <a href="ReadOnlyKeyValueStore.html#reverseRange(K,K)">reverseRange</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.streams.processor.StateStore">Methods inherited from interface org.apache.kafka.streams.processor.<a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></h3> |
| <code><a href="../processor/StateStore.html#close()">close</a>, <a href="../processor/StateStore.html#flush()">flush</a>, <a href="../processor/StateStore.html#getPosition()">getPosition</a>, <a href="../processor/StateStore.html#init(org.apache.kafka.streams.processor.ProcessorContext,org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../processor/StateStore.html#init(org.apache.kafka.streams.processor.StateStoreContext,org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../processor/StateStore.html#isOpen()">isOpen</a>, <a href="../processor/StateStore.html#name()">name</a>, <a href="../processor/StateStore.html#persistent()">persistent</a>, <a href="../processor/StateStore.html#query(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.query.PositionBound,org.apache.kafka.streams.query.QueryConfig)">query</a></code></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="put(K,V)"> |
| <h3 id="put(java.lang.Object,java.lang.Object)">put</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, |
| <a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</span></div> |
| <div class="block">Update the value associated with this key.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The key to associate the value to</dd> |
| <dd><code>value</code> - The value to update, it can be <code>null</code>; |
| if the serialized bytes are also <code>null</code> it is interpreted as deletes</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If <code>null</code> is used for key.</dd> |
| <dd><code><a href="../errors/InvalidStateStoreException.html" title="class in org.apache.kafka.streams.errors">InvalidStateStoreException</a></code> - if the store is not initialized</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(K,V)"> |
| <h3 id="putIfAbsent(java.lang.Object,java.lang.Object)">putIfAbsent</h3> |
| <div class="member-signature"><span class="return-type"><a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a></span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key, |
| <a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a> value)</span></div> |
| <div class="block">Update the value associated with this key, unless a value is already associated with the key.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The key to associate the value to</dd> |
| <dd><code>value</code> - The value to update, it can be <code>null</code>; |
| if the serialized bytes are also <code>null</code> it is interpreted as deletes</dd> |
| <dt>Returns:</dt> |
| <dd>The old value or <code>null</code> if there is no such key.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If <code>null</code> is used for key.</dd> |
| <dd><code><a href="../errors/InvalidStateStoreException.html" title="class in org.apache.kafka.streams.errors">InvalidStateStoreException</a></code> - if the store is not initialized</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putAll(java.util.List)"> |
| <h3>putAll</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">putAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../KeyValue.html" title="class in org.apache.kafka.streams">KeyValue</a><<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<wbr><a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a>>> entries)</span></div> |
| <div class="block">Update all the given key/value pairs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>entries</code> - A list of entries to put into the store; |
| if the serialized bytes are also <code>null</code> it is interpreted as deletes</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If <code>null</code> is used for key.</dd> |
| <dd><code><a href="../errors/InvalidStateStoreException.html" title="class in org.apache.kafka.streams.errors">InvalidStateStoreException</a></code> - if the store is not initialized</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(K)"> |
| <h3 id="delete(java.lang.Object)">delete</h3> |
| <div class="member-signature"><span class="return-type"><a href="KeyValueStore.html" title="type parameter in KeyValueStore">V</a></span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="KeyValueStore.html" title="type parameter in KeyValueStore">K</a> key)</span></div> |
| <div class="block">Delete the value from the store (if there is one).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The key</dd> |
| <dt>Returns:</dt> |
| <dd>The old value or <code>null</code> if there is no such key.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If <code>null</code> is used for key.</dd> |
| <dd><code><a href="../errors/InvalidStateStoreException.html" title="class in org.apache.kafka.streams.errors">InvalidStateStoreException</a></code> - if the store is not initialized</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
