blob: b1fec8b123595fcc857f4a5c4e1de7d3dc3a4906 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>StreamDescribedTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StreamDescribedTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StreamDescribedTypeDecoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.codec</a></div>
<h2 title="Interface StreamDescribedTypeDecoder" class="title">Interface StreamDescribedTypeDecoder&lt;V&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - The type this decoder handles</dd>
</dl>
<dl>
<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>
<dt>All Known Implementing Classes:</dt>
<dd><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>
<pre>public interface <span class="typeNameLabel">StreamDescribedTypeDecoder&lt;V&gt;</span>
extends <a href="StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</pre>
<div class="block">Interface for all DescribedType decoder implementations</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptorCode()">getDescriptorCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the AMQP descriptor code for the type this decoder reads.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptorSymbol()">getDescriptorSymbol</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the AMQP descriptor symbol for the type this decoder reads.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.StreamTypeDecoder">
<!-- -->
</a>
<h3>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#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">readArrayElements</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></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getDescriptorCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptorCode</h4>
<pre class="methodSignature"><a href="../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a>&nbsp;getDescriptorCode()</pre>
<div class="block">Returns the AMQP descriptor code for the type this decoder reads.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unsigned long descriptor code value.</dd>
</dl>
</li>
</ul>
<a id="getDescriptorSymbol()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDescriptorSymbol</h4>
<pre class="methodSignature"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&nbsp;getDescriptorSymbol()</pre>
<div class="block">Returns the AMQP descriptor symbol for the type this decoder reads.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an symbol descriptor code value.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StreamDescribedTypeDecoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>