blob: 3e1fd42230503ea36fc280534149861846675a2b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>StreamDescribedTypeDecoder (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, interface: StreamDescribedTypeDecoder">
<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/StreamDescribedTypeDecoder.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.codec</a></div>
<h1 title="Interface StreamDescribedTypeDecoder" class="title">Interface StreamDescribedTypeDecoder&lt;V&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>V</code> - The type this decoder handles</dd>
</dl>
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="decoders/AbstractDescribedListTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedListTypeDecoder</a></code>, <code><a href="decoders/AbstractDescribedMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedMapTypeDecoder</a></code>, <code><a href="decoders/AbstractDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedTypeDecoder</a></code>, <code><a href="decoders/messaging/AcceptedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AcceptedTypeDecoder</a></code>, <code><a href="decoders/messaging/AmqpSequenceTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AmqpSequenceTypeDecoder</a></code>, <code><a href="decoders/messaging/AmqpValueTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AmqpValueTypeDecoder</a></code>, <code><a href="decoders/messaging/ApplicationPropertiesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ApplicationPropertiesTypeDecoder</a></code>, <code><a href="decoders/transport/AttachTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">AttachTypeDecoder</a></code>, <code><a href="decoders/transport/BeginTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">BeginTypeDecoder</a></code>, <code><a href="decoders/transport/CloseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">CloseTypeDecoder</a></code>, <code><a href="decoders/transactions/CoordinatorTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">CoordinatorTypeDecoder</a></code>, <code><a href="decoders/messaging/DataTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DataTypeDecoder</a></code>, <code><a href="decoders/transactions/DeclaredTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DeclaredTypeDecoder</a></code>, <code><a href="decoders/transactions/DeclareTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DeclareTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnCloseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnCloseTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoLinksOrMessagesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoLinksOrMessagesTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoLinksTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoLinksTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoMessagesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoMessagesTypeDecoder</a></code>, <code><a href="decoders/messaging/DeliveryAnnotationsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeliveryAnnotationsTypeDecoder</a></code>, <code><a href="decoders/transport/DetachTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">DetachTypeDecoder</a></code>, <code><a href="decoders/transactions/DischargeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DischargeTypeDecoder</a></code>, <code><a href="decoders/transport/DispositionTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">DispositionTypeDecoder</a></code>, <code><a href="decoders/transport/EndTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">EndTypeDecoder</a></code>, <code><a href="decoders/transport/ErrorConditionTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">ErrorConditionTypeDecoder</a></code>, <code><a href="decoders/transport/FlowTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">FlowTypeDecoder</a></code>, <code><a href="decoders/messaging/FooterTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">FooterTypeDecoder</a></code>, <code><a href="decoders/messaging/HeaderTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">HeaderTypeDecoder</a></code>, <code><a href="decoders/messaging/MessageAnnotationsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">MessageAnnotationsTypeDecoder</a></code>, <code><a href="decoders/messaging/ModifiedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ModifiedTypeDecoder</a></code>, <code><a href="decoders/transport/OpenTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">OpenTypeDecoder</a></code>, <code><a href="decoders/messaging/PropertiesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">PropertiesTypeDecoder</a></code>, <code><a href="decoders/messaging/ReceivedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ReceivedTypeDecoder</a></code>, <code><a href="decoders/messaging/RejectedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">RejectedTypeDecoder</a></code>, <code><a href="decoders/messaging/ReleasedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ReleasedTypeDecoder</a></code>, <code><a href="decoders/security/SaslChallengeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslChallengeTypeDecoder</a></code>, <code><a href="decoders/security/SaslInitTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslInitTypeDecoder</a></code>, <code><a href="decoders/security/SaslMechanismsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslMechanismsTypeDecoder</a></code>, <code><a href="decoders/security/SaslOutcomeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslOutcomeTypeDecoder</a></code>, <code><a href="decoders/security/SaslResponseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslResponseTypeDecoder</a></code>, <code><a href="decoders/messaging/SourceTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">SourceTypeDecoder</a></code>, <code><a href="decoders/messaging/TargetTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">TargetTypeDecoder</a></code>, <code><a href="decoders/transactions/TransactionStateTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">TransactionStateTypeDecoder</a></code>, <code><a href="decoders/transport/TransferTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">TransferTypeDecoder</a></code>, <code><a href="decoders/UnknownDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">UnknownDescribedTypeDecoder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StreamDescribedTypeDecoder&lt;V&gt;</span><span class="extends-implements">
extends <a href="StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</span></div>
<div class="block">Interface for all DescribedType decoder implementations</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="../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-tab3"><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-tab3">
<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-tab3"><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-tab3"><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-tab3">
<div class="block">Returns the AMQP descriptor symbol for the type this decoder reads.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.StreamTypeDecoder">Methods inherited from interface&nbsp;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#getTypeClass()">getTypeClass</a>, <a href="StreamTypeDecoder.html#isArrayType()">isArrayType</a>, <a href="StreamTypeDecoder.html#isNull()">isNull</a>, <a href="StreamTypeDecoder.html#isPrimitive()">isPrimitive</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>
</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="getDescriptorCode()">
<h3>getDescriptorCode</h3>
<div class="member-signature"><span class="return-type"><a href="../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></span>&nbsp;<span class="element-name">getDescriptorCode</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="return-type"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></span>&nbsp;<span class="element-name">getDescriptorSymbol</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>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>