blob: 833e56b89840a16c995e1d83ca2a12b61fe920bd [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DescribedTypeEncoder (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="DescribedTypeEncoder (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/DescribedTypeEncoder.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 DescribedTypeEncoder" class="title">Interface DescribedTypeEncoder&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="TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a>&lt;V&gt;</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="encoders/AbstractDescribedListTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractDescribedListTypeEncoder</a></code>, <code><a href="encoders/AbstractDescribedMapTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractDescribedMapTypeEncoder</a></code>, <code><a href="encoders/AbstractDescribedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractDescribedTypeEncoder</a></code>, <code><a href="encoders/messaging/AcceptedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">AcceptedTypeEncoder</a></code>, <code><a href="encoders/messaging/AmqpSequenceTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">AmqpSequenceTypeEncoder</a></code>, <code><a href="encoders/messaging/AmqpValueTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">AmqpValueTypeEncoder</a></code>, <code><a href="encoders/messaging/ApplicationPropertiesTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">ApplicationPropertiesTypeEncoder</a></code>, <code><a href="encoders/transport/AttachTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">AttachTypeEncoder</a></code>, <code><a href="encoders/transport/BeginTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">BeginTypeEncoder</a></code>, <code><a href="encoders/transport/CloseTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">CloseTypeEncoder</a></code>, <code><a href="encoders/transactions/CoordinatorTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transactions">CoordinatorTypeEncoder</a></code>, <code><a href="encoders/messaging/DataTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DataTypeEncoder</a></code>, <code><a href="encoders/transactions/DeclaredTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transactions">DeclaredTypeEncoder</a></code>, <code><a href="encoders/transactions/DeclareTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transactions">DeclareTypeEncoder</a></code>, <code><a href="encoders/messaging/DeleteOnCloseTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeleteOnCloseTypeEncoder</a></code>, <code><a href="encoders/messaging/DeleteOnNoLinksOrMessagesTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeleteOnNoLinksOrMessagesTypeEncoder</a></code>, <code><a href="encoders/messaging/DeleteOnNoLinksTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeleteOnNoLinksTypeEncoder</a></code>, <code><a href="encoders/messaging/DeleteOnNoMessagesTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeleteOnNoMessagesTypeEncoder</a></code>, <code><a href="encoders/messaging/DeliveryAnnotationsTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeliveryAnnotationsTypeEncoder</a></code>, <code><a href="encoders/transport/DetachTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">DetachTypeEncoder</a></code>, <code><a href="encoders/transactions/DischargeTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transactions">DischargeTypeEncoder</a></code>, <code><a href="encoders/transport/DispositionTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">DispositionTypeEncoder</a></code>, <code><a href="encoders/transport/EndTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">EndTypeEncoder</a></code>, <code><a href="encoders/transport/ErrorConditionTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">ErrorConditionTypeEncoder</a></code>, <code><a href="encoders/transport/FlowTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">FlowTypeEncoder</a></code>, <code><a href="encoders/messaging/FooterTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">FooterTypeEncoder</a></code>, <code><a href="encoders/messaging/HeaderTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">HeaderTypeEncoder</a></code>, <code><a href="encoders/messaging/MessageAnnotationsTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">MessageAnnotationsTypeEncoder</a></code>, <code><a href="encoders/messaging/ModifiedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">ModifiedTypeEncoder</a></code>, <code><a href="encoders/transport/OpenTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">OpenTypeEncoder</a></code>, <code><a href="encoders/messaging/PropertiesTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">PropertiesTypeEncoder</a></code>, <code><a href="encoders/messaging/ReceivedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">ReceivedTypeEncoder</a></code>, <code><a href="encoders/messaging/RejectedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">RejectedTypeEncoder</a></code>, <code><a href="encoders/messaging/ReleasedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">ReleasedTypeEncoder</a></code>, <code><a href="encoders/security/SaslChallengeTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.security">SaslChallengeTypeEncoder</a></code>, <code><a href="encoders/security/SaslInitTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.security">SaslInitTypeEncoder</a></code>, <code><a href="encoders/security/SaslMechanismsTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.security">SaslMechanismsTypeEncoder</a></code>, <code><a href="encoders/security/SaslOutcomeTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.security">SaslOutcomeTypeEncoder</a></code>, <code><a href="encoders/security/SaslResponseTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.security">SaslResponseTypeEncoder</a></code>, <code><a href="encoders/messaging/SourceTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">SourceTypeEncoder</a></code>, <code><a href="encoders/messaging/TargetTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">TargetTypeEncoder</a></code>, <code><a href="encoders/transactions/TransactionStateTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transactions">TransactionStateTypeEncoder</a></code>, <code><a href="encoders/transport/TransferTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.transport">TransferTypeEncoder</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">DescribedTypeEncoder&lt;V&gt;</span>
extends <a href="TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a>&lt;V&gt;</pre>
<div class="block">Interface for all DescribedType encoder 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">&nbsp;</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">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.TypeEncoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.<a href="TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a></h3>
<code><a href="TypeEncoder.html#getTypeClass()">getTypeClass</a>, <a href="TypeEncoder.html#isArrayType()">isArrayType</a>, <a href="TypeEncoder.html#writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">writeArray</a>, <a href="TypeEncoder.html#writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">writeRawArray</a>, <a href="TypeEncoder.html#writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,V)">writeType</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>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the UnsignedLong value to use as the Descriptor for this type.</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>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Symbol value to use as the Descriptor for this type.</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/DescribedTypeEncoder.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>