Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / content / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / codec / encoders / AbstractDescribedMapTypeEncoder.html
blob: d4f1aeae8939ef22b754370af475f74551ef399a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractDescribedMapTypeEncoder (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="AbstractDescribedMapTypeEncoder (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":6,"i2":6,"i3":10,"i4":6,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/AbstractDescribedMapTypeEncoder.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.encoders</a></div>
<h2 title="Class AbstractDescribedMapTypeEncoder" class="title">Class AbstractDescribedMapTypeEncoder&lt;K,&#8203;V,&#8203;M&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractDescribedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">org.apache.qpid.protonj2.codec.encoders.AbstractDescribedTypeEncoder</a>&lt;M&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.codec.encoders.AbstractDescribedMapTypeEncoder&lt;K,&#8203;V,&#8203;M&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>M</code> - the map type that is being encoded.</dd>
<dd><code>K</code> - the key type used for the encoded map's keys.</dd>
<dd><code>V</code> - the value type used for the encoded map's values.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../DescribedTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeEncoder</a>&lt;M&gt;</code>, <code><a href="../TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a>&lt;M&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="messaging/ApplicationPropertiesTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">ApplicationPropertiesTypeEncoder</a></code>, <code><a href="messaging/DeliveryAnnotationsTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">DeliveryAnnotationsTypeEncoder</a></code>, <code><a href="messaging/FooterTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">FooterTypeEncoder</a></code>, <code><a href="messaging/MessageAnnotationsTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.messaging">MessageAnnotationsTypeEncoder</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractDescribedMapTypeEncoder&lt;K,&#8203;V,&#8203;M&gt;</span>
extends <a href="AbstractDescribedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractDescribedTypeEncoder</a>&lt;M&gt;</pre>
<div class="block">Base class used for all Described Type objects that are represented as a List</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractDescribedMapTypeEncoder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapEncoding(M)">getMapEncoding</a></span>&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Determine the map type the given value can be encoded to based on the number
of bytes that would be needed to hold the encoded form of the resulting list
entries.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapSize(M)">getMapSize</a></span>&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Gets the number of elements that will result when this type is encoded
into an AMQP Map type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasMap(M)">hasMap</a></span>&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Returns false when the value to be encoded has no Map body and can be
written as a Null body type instead of a Map type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">writeArray</a></span>&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;values)</code></th>
<td class="colLast">
<div class="block">Write an array elements of the AMQP type to the given byte buffer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeMapEntries(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,M)">writeMapEntries</a></span>&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Performs the write of the Map entries to the given buffer, the caller
takes care of writing the Map preamble and tracking the final size of
the written elements of the Map.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">writeRawArray</a></span>&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;values)</code></th>
<td class="colLast">
<div class="block">Write an array elements of the AMQP type to the given byte buffer.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,M)">writeType</a></span>&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Write the full AMQP type data to the given byte buffer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.encoders.AbstractDescribedTypeEncoder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.qpid.protonj2.codec.encoders.<a href="AbstractDescribedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractDescribedTypeEncoder</a></h3>
<code><a href="AbstractDescribedTypeEncoder.html#isArrayType()">isArrayType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.DescribedTypeEncoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.<a href="../DescribedTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeEncoder</a></h3>
<code><a href="../DescribedTypeEncoder.html#getDescriptorCode()">getDescriptorCode</a>, <a href="../DescribedTypeEncoder.html#getDescriptorSymbol()">getDescriptorSymbol</a></code></li>
</ul>
<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></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractDescribedMapTypeEncoder</h4>
<pre>public&nbsp;AbstractDescribedMapTypeEncoder()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getMapEncoding(java.lang.Object)">
<!-- -->
</a><a id="getMapEncoding(M)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapEncoding</h4>
<pre class="methodSignature">public&nbsp;byte&nbsp;getMapEncoding&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</pre>
<div class="block">Determine the map type the given value can be encoded to based on the number
of bytes that would be needed to hold the encoded form of the resulting list
entries.
<p>
Most encoders will return MAP32 but for cases where the type is known to
be encoded to MAP8 the encoder can optimize the encode step and not compute
sizes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The value that is to be encoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoding code of the map type encoding needed for this object.</dd>
</dl>
</li>
</ul>
<a id="hasMap(java.lang.Object)">
<!-- -->
</a><a id="hasMap(M)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMap</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;hasMap&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</pre>
<div class="block">Returns false when the value to be encoded has no Map body and can be
written as a Null body type instead of a Map type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value which be encoded as a map type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the type to be encoded has a Map body, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="getMapSize(java.lang.Object)">
<!-- -->
</a><a id="getMapSize(M)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapSize</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;getMapSize&#8203;(<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</pre>
<div class="block">Gets the number of elements that will result when this type is encoded
into an AMQP Map type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value which will be encoded as a map type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of elements that should comprise the encoded list.</dd>
</dl>
</li>
</ul>
<a id="writeMapEntries(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object)">
<!-- -->
</a><a id="writeMapEntries(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,M)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeMapEntries</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;writeMapEntries&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</pre>
<div class="block">Performs the write of the Map entries to the given buffer, the caller
takes care of writing the Map preamble and tracking the final size of
the written elements of the Map.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - the buffer where the type should be encoded to.</dd>
<dd><code>state</code> - the current encoder state.</dd>
<dd><code>value</code> - the value which will be encoded as a map type.</dd>
</dl>
</li>
</ul>
<a id="writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object)">
<!-- -->
</a><a id="writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,M)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeType</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;writeType&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="AbstractDescribedMapTypeEncoder.html" title="type parameter in AbstractDescribedMapTypeEncoder">M</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../TypeEncoder.html#writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,V)">TypeEncoder</a></code></span></div>
<div class="block">Write the full AMQP type data to the given byte buffer.
<p>
This can consist of writing both a type constructor value and
the bytes that make up the value of the type being written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to write the AMQP type to</dd>
<dd><code>state</code> - The current encoder state</dd>
<dd><code>value</code> - The value that is to be written.</dd>
</dl>
</li>
</ul>
<a id="writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeArray</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;writeArray&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../TypeEncoder.html#writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">TypeEncoder</a></code></span></div>
<div class="block">Write an array elements of the AMQP type to the given byte buffer.
<p>
This method writes the full Array type definition of an array of the
type this encoder manages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to write the AMQP array elements to</dd>
<dd><code>state</code> - The current encoder state</dd>
<dd><code>values</code> - The array of values that is to be written.</dd>
</dl>
</li>
</ul>
<a id="writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeRawArray</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;writeRawArray&#8203;(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a>&nbsp;state,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../TypeEncoder.html#writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)">TypeEncoder</a></code></span></div>
<div class="block">Write an array elements of the AMQP type to the given byte buffer.
<p>
This method writes only the body portion of an AMQP array of this type, the
array encoding, size and element count should be assumed to be managed by
the caller.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to write the AMQP array elements to</dd>
<dd><code>state</code> - The current encoder state</dd>
<dd><code>values</code> - The array of values that is to be written.</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/AbstractDescribedMapTypeEncoder.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>