| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FooterTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M19 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.messaging, class: FooterTypeDecoder"> |
| <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/FooterTypeDecoder.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><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.messaging</a></div> |
| <h1 title="Class FooterTypeDecoder" class="title">Class FooterTypeDecoder</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">org.apache.qpid.protonj2.codec.decoders.AbstractDescribedTypeDecoder</a><V> |
| <div class="inheritance"><a href="../AbstractDescribedMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">org.apache.qpid.protonj2.codec.decoders.AbstractDescribedMapTypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>> |
| <div class="inheritance">org.apache.qpid.protonj2.codec.decoders.messaging.FooterTypeDecoder</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../DescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></code>, <code><a href="../../StreamDescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDescribedTypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></code>, <code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></code>, <code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">FooterTypeDecoder</span> |
| <span class="extends-implements">extends <a href="../AbstractDescribedMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedMapTypeDecoder</a><<a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></span></div> |
| <div class="block">Decoder of AMQP Footer type values from a byte stream.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FooterTypeDecoder</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab1 method-summary-table-tab4"><code>static <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScanContext(java.util.Collection)" class="member-name-link">createScanContext</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScanContext(org.apache.qpid.protonj2.types.Symbol...)" class="member-name-link">createScanContext</a><wbr>(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... keys)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createStreamScanContext(java.util.Collection)" class="member-name-link">createStreamScanContext</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createStreamScanContext(org.apache.qpid.protonj2.types.Symbol...)" class="member-name-link">createStreamScanContext</a><wbr>(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... keys)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescriptorCode()" class="member-name-link">getDescriptorCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the AMQP descriptor code for the type this decoder reads.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescriptorSymbol()" class="member-name-link">getDescriptorSymbol</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the AMQP descriptor symbol for the type this decoder reads.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)" class="member-name-link">readArrayElements</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, |
| int count)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)" class="member-name-link">readArrayElements</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, |
| int count)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)" class="member-name-link">readValue</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-tab4"> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)" class="member-name-link">readValue</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-tab4"> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#scanAnnotations(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,org.apache.qpid.protonj2.codec.decoders.StreamScanningContext,java.util.function.BiConsumer)" class="member-name-link">scanAnnotations</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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> 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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<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-tab4"> |
| <div class="block">Scans through the encoded <a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> map looking for keys that match with |
| the provided <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#scanAnnotations(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">scanAnnotations</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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> 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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<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-tab4"> |
| <div class="block">Scans through the encoded <a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> map looking for keys that match with |
| the provided <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.decoders.AbstractDescribedMapTypeDecoder">Methods inherited from class org.apache.qpid.protonj2.codec.decoders.<a href="../AbstractDescribedMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedMapTypeDecoder</a></h3> |
| <code><a href="../AbstractDescribedMapTypeDecoder.html#scanMapEntries(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,org.apache.qpid.protonj2.codec.decoders.StreamScanningContext,java.util.function.BiConsumer)">scanMapEntries</a>, <a href="../AbstractDescribedMapTypeDecoder.html#scanMapEntries(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,org.apache.qpid.protonj2.codec.decoders.ScanningContext,java.util.function.BiConsumer)">scanMapEntries</a>, <a href="../AbstractDescribedMapTypeDecoder.html#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">skipValue</a>, <a href="../AbstractDescribedMapTypeDecoder.html#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">skipValue</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.decoders.AbstractDescribedTypeDecoder">Methods inherited from class org.apache.qpid.protonj2.codec.decoders.<a href="../AbstractDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedTypeDecoder</a></h3> |
| <code><a href="../AbstractDescribedTypeDecoder.html#checkIsExpectedType(java.lang.Class,org.apache.qpid.protonj2.codec.StreamTypeDecoder)">checkIsExpectedType</a>, <a href="../AbstractDescribedTypeDecoder.html#checkIsExpectedType(java.lang.Class,org.apache.qpid.protonj2.codec.TypeDecoder)">checkIsExpectedType</a>, <a href="../AbstractDescribedTypeDecoder.html#checkIsExpectedTypeAndCast(java.lang.Class,org.apache.qpid.protonj2.codec.StreamTypeDecoder)">checkIsExpectedTypeAndCast</a>, <a href="../AbstractDescribedTypeDecoder.html#checkIsExpectedTypeAndCast(java.lang.Class,org.apache.qpid.protonj2.codec.TypeDecoder)">checkIsExpectedTypeAndCast</a>, <a href="../AbstractDescribedTypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../AbstractDescribedTypeDecoder.html#isNull()">isNull</a>, <a href="../AbstractDescribedTypeDecoder.html#isPrimitive()">isPrimitive</a>, <a href="../AbstractDescribedTypeDecoder.html#readSize(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readSize</a>, <a href="../AbstractDescribedTypeDecoder.html#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readSize</a>, <a href="../AbstractDescribedTypeDecoder.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.DescribedTypeDecoder">Methods inherited from interface org.apache.qpid.protonj2.codec.<a href="../../DescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeDecoder</a></h3> |
| <code><a href="../../DescribedTypeDecoder.html#decoderRegistered(org.apache.qpid.protonj2.codec.Decoder)">decoderRegistered</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>FooterTypeDecoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FooterTypeDecoder</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ 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">public</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="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>></span> <span class="element-name">getTypeClass</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Class that this decoder handles.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescriptorCode()"> |
| <h3>getDescriptorCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></span> <span class="element-name">getDescriptorCode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../DescribedTypeDecoder.html#getDescriptorCode()">DescribedTypeDecoder</a></code></span></div> |
| <div class="block">Returns the AMQP descriptor code for the type this decoder reads.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an unsigned long descriptor code value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescriptorSymbol()"> |
| <h3>getDescriptorSymbol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></span> <span class="element-name">getDescriptorSymbol</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../DescribedTypeDecoder.html#getDescriptorSymbol()">DescribedTypeDecoder</a></code></span></div> |
| <div class="block">Returns the AMQP descriptor symbol for the type this decoder reads.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an symbol descriptor code value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)"> |
| <h3>readValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a></span> <span class="element-name">readValue</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../TypeDecoder.html#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">TypeDecoder</a></code></span></div> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)"> |
| <h3>readArrayElements</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>[]</span> <span class="element-name">readArrayElements</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, |
| int count)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../TypeDecoder.html#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)">TypeDecoder</a></code></span></div> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type. |
| <p> |
| When encoded into an array the values are encoded in series following the identifier |
| for the type, this method is given a count of the number of instances that are encoded |
| and should read each in succession and returning them in a new array.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dd><code>count</code> - the number of array elements encoded in the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)"> |
| <h3>readValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a></span> <span class="element-name">readValue</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../StreamTypeDecoder.html#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">StreamTypeDecoder</a></code></span></div> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)"> |
| <h3>readArrayElements</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging">Footer</a>[]</span> <span class="element-name">readArrayElements</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, |
| int count)</span> |
| throws <span class="exceptions"><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../StreamTypeDecoder.html#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">StreamTypeDecoder</a></code></span></div> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type. |
| <p> |
| When encoded into an array the values are encoded in series following the identifier |
| for the type, this method is given a count of the number of instances that are encoded |
| and should read each in succession and returning them in a new array.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dd><code>count</code> - the number of array elements encoded in the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createScanContext(org.apache.qpid.protonj2.types.Symbol...)"> |
| <h3>createScanContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></span> <span class="element-name">createScanContext</span><wbr><span class="parameters">(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... keys)</span></div> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keys</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> keys that will be scanned for in 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></dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a> for the collection of string keys.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createScanContext(java.util.Collection)"> |
| <h3>createScanContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">ScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></span> <span class="element-name">createScanContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> keys)</span></div> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keys</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> keys that will be scanned for in 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></dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a> for the collection of string keys.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamScanContext(org.apache.qpid.protonj2.types.Symbol...)"> |
| <h3>createStreamScanContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></span> <span class="element-name">createStreamScanContext</span><wbr><span class="parameters">(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... keys)</span></div> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keys</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> keys that will be scanned for in 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></dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a> for the collection of Symbol keys.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamScanContext(java.util.Collection)"> |
| <h3>createStreamScanContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../StreamScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders">StreamScanningContext</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>></span> <span class="element-name">createStreamScanContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> keys)</span></div> |
| <div class="block">Creates a new scanning context for the given collection of <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types"><code>Symbol</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keys</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> keys that will be scanned for in 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></dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a> for the collection of Symbol keys.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scanAnnotations(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,org.apache.qpid.protonj2.codec.decoders.ScanningContext,java.util.function.BiConsumer)"> |
| <h3>scanAnnotations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">scanAnnotations</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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> 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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<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">Scans through the encoded <a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> map looking for keys that match with |
| the provided <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a>. When a match is found the provided match consumer |
| is called with the matched key and the decoded value mapped to that key. When the method |
| returns the caller can assume that all bytes of the encoded Footer have been read and |
| that decoding of the next object can begin if the provided buffer remains readable.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer to scan for specific key / value mappings</dd> |
| <dd><code>state</code> - The decoder state used during the scanning</dd> |
| <dd><code>context</code> - A matching context primed with the match data needed to match encoded keys.</dd> |
| <dd><code>matchConsumer</code> - A <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> that will be notified of each matching key / value pair.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scanAnnotations(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,org.apache.qpid.protonj2.codec.decoders.StreamScanningContext,java.util.function.BiConsumer)"> |
| <h3>scanAnnotations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">scanAnnotations</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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>> 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><<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<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">Scans through the encoded <a href="../../../types/messaging/Footer.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Footer</code></a> map looking for keys that match with |
| the provided <a href="../ScanningContext.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>ScanningContext</code></a>. When a match is found the provided match consumer |
| is called with the matched key and the decoded value mapped to that key. When the method |
| returns the caller can assume that all bytes of the encoded Footer have been read and |
| that decoding of the next object can begin if the provided stream remains readable.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - The <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"><code>InputStream</code></a> to scan for specific key / value mappings</dd> |
| <dd><code>state</code> - The decoder state used during the scanning</dd> |
| <dd><code>context</code> - A matching context primed with the match data needed to match encoded keys.</dd> |
| <dd><code>matchConsumer</code> - A <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> that will be notified of each matching key / value pair.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error is encountered while reading the next 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 © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
