| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MapTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M18 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.qpid.protonj2.codec.decoders.primitives, interface: MapTypeDecoder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.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"; |
| </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/MapTypeDecoder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</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> |
| <!-- ========= 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.qpid.protonj2.codec.decoders.primitives</a></div> |
| <h1 title="Interface MapTypeDecoder" class="title">Interface MapTypeDecoder</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code>, <code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code>, <code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractMapTypeDecoder</a></code>, <code><a href="Map32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map32TypeDecoder</a></code>, <code><a href="Map8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map8TypeDecoder</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MapTypeDecoder</span><span class="extends-implements"> |
| extends <a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></span></div> |
| <div class="block">Base interface for all AMQP Map type value decoders.</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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getTypeClass()" class="member-name-link">getTypeClass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readCount(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)" class="member-name-link">readCount</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads the count of entries in the encoded Map.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readCount(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)" class="member-name-link">readCount</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads the count of entries in the encoded Map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><KeyType> void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scanKeys(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,org.apache.qpid.protonj2.codec.decoders.StreamScanningContext,java.util.function.BiConsumer)" class="member-name-link">scanKeys</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state, |
| <a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><KeyType> context, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><KeyType,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> matchConsumer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Scan the encoded <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> keys matching on predetermined key value encodings to quickly |
| find mappings that are of interest and then only decoding the value portion of the matched |
| key / value pair.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><KeyType> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scanKeys(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,org.apache.qpid.protonj2.codec.decoders.ScanningContext,java.util.function.BiConsumer)" class="member-name-link">scanKeys</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a> state, |
| <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><KeyType> context, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><KeyType,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> matchConsumer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Scan the encoded <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> keys matching on predetermined key value encodings to quickly |
| find mappings that are of interest and then only decoding the value portion of the matched |
| key / value pair.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.decoders.PrimitiveTypeDecoder">Methods inherited from interface org.apache.qpid.protonj2.codec.decoders.<a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a></h3> |
| <code><a href="../PrimitiveTypeDecoder.html#getTypeCode()">getTypeCode</a>, <a href="../PrimitiveTypeDecoder.html#isJavaPrimitive()">isJavaPrimitive</a>, <a href="../PrimitiveTypeDecoder.html#isPrimitive()">isPrimitive</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.StreamTypeDecoder">Methods inherited from interface org.apache.qpid.protonj2.codec.<a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a></h3> |
| <code><a href="../../StreamTypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../../StreamTypeDecoder.html#isNull()">isNull</a>, <a href="../../StreamTypeDecoder.html#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">readArrayElements</a>, <a href="../../StreamTypeDecoder.html#readSize(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readSize</a>, <a href="../../StreamTypeDecoder.html#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValue</a>, <a href="../../StreamTypeDecoder.html#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">skipValue</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.TypeDecoder">Methods inherited from interface org.apache.qpid.protonj2.codec.<a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a></h3> |
| <code><a href="../../TypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../../TypeDecoder.html#isNull()">isNull</a>, <a href="../../TypeDecoder.html#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)">readArrayElements</a>, <a href="../../TypeDecoder.html#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readSize</a>, <a href="../../TypeDecoder.html#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValue</a>, <a href="../../TypeDecoder.html#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">skipValue</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="getTypeClass()"> |
| <h3>getTypeClass</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></span> <span class="element-name">getTypeClass</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../StreamTypeDecoder.html#getTypeClass()">getTypeClass</a></code> in interface <code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../TypeDecoder.html#getTypeClass()">getTypeClass</a></code> in interface <code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the Class that this decoder handles.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCount(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)"> |
| <h3>readCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">readCount</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a> state)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Reads the count of entries in the encoded Map. |
| <p> |
| This value is the total count of all key values pairs, and should |
| always be an even number as Map types cannot be unbalanced.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer containing the encoded Map type.</dd> |
| <dd><code>state</code> - The <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>DecoderState</code></a> used during this decode.</dd> |
| <dt>Returns:</dt> |
| <dd>the number of elements that we encoded from the original Map.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs reading the value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCount(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)"> |
| <h3>readCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">readCount</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Reads the count of entries in the encoded Map. |
| <p> |
| This value is the total count of all key values pairs, and should |
| always be an even number as Map types cannot be unbalanced.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - The InputStream containing the encoded Map type.</dd> |
| <dd><code>state</code> - The <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> used during this decode.</dd> |
| <dt>Returns:</dt> |
| <dd>the number of elements that we encoded from the original Map.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs reading the value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scanKeys(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,org.apache.qpid.protonj2.codec.decoders.ScanningContext,java.util.function.BiConsumer)"> |
| <h3>scanKeys</h3> |
| <div class="member-signature"><span class="type-parameters"><KeyType></span> <span class="return-type">void</span> <span class="element-name">scanKeys</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a> state, |
| <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><KeyType> context, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><KeyType,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> matchConsumer)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Scan the encoded <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> keys matching on predetermined key value encodings to quickly |
| find mappings that are of interest and then only decoding the value portion of the matched |
| key / value pair. This allows for quick checks of incoming <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> types without the |
| performance penalty of a full decode. After the method returns the contexts of the encoded |
| Map in the provided buffer will have been consumed and the next type can be decoded. |
| <p> |
| Each matching key / value mapping triggers a call to the provided <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link"><code>BiConsumer</code></a> with |
| the key that triggered the match (generally a cached non-decoded value) and the decoded |
| value mapped to that key. The caller should use the consumer to trigger actions based on |
| the matches found in the mappings which avoid full decodings of large maps when only a |
| limited set of values is desired.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>KeyType</code> - The key type is used when calling the match consumer</dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer containing the encoded Map type.</dd> |
| <dd><code>state</code> - The <a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>DecoderState</code></a> used during this decode.</dd> |
| <dd><code>context</code> - The previously created and configured <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a></dd> |
| <dd><code>matchConsumer</code> - The consumer that will be notified when a matching key is found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs reading the value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scanKeys(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,org.apache.qpid.protonj2.codec.decoders.StreamScanningContext,java.util.function.BiConsumer)"> |
| <h3>scanKeys</h3> |
| <div class="member-signature"><span class="type-parameters"><KeyType></span> <span class="return-type">void</span> <span class="element-name">scanKeys</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state, |
| <a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><KeyType> context, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><KeyType,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> matchConsumer)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Scan the encoded <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> keys matching on predetermined key value encodings to quickly |
| find mappings that are of interest and then only decoding the value portion of the matched |
| key / value pair. This allows for quick checks of incoming <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> types without the |
| performance penalty of a full decode. After the method returns the contexts of the encoded |
| Map in the provided stream will have been consumed and the next type can be decoded. |
| <p> |
| Each matching key / value mapping triggers a call to the provided <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link"><code>BiConsumer</code></a> with |
| the key that triggered the match (generally a cached non-decoded value) and the decoded |
| value mapped to that key. The caller should use the consumer to trigger actions based on |
| the matches found in the mappings which avoid full decodings of large maps when only a |
| limited set of values is desired.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>KeyType</code> - The key type is used when calling the match consumer</dd> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - The InputStream containing the encoded Map type.</dd> |
| <dd><code>state</code> - The <a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> used during this decode.</dd> |
| <dd><code>context</code> - The previously created and configured <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a></dd> |
| <dd><code>matchConsumer</code> - The consumer that will be notified when a matching key is found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs reading the value</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
