blob: 74c76e254fb51e8aca9a922bc4a0b2121eefd7ae [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TypeEncoder (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: TypeEncoder">
<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/TypeEncoder.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 TypeEncoder" class="title">Interface TypeEncoder&lt;V&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>V</code> - the concrete Type that this encoder handles.</dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="DescribedTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeEncoder</a>&lt;V&gt;</code>, <code><a href="encoders/PrimitiveTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders">PrimitiveTypeEncoder</a>&lt;V&gt;</code></dd>
</dl>
<dl class="notes">
<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/AbstractPrimitiveTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">AbstractPrimitiveTypeEncoder</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/primitives/ArrayTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">ArrayTypeEncoder</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/primitives/BinaryTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">BinaryTypeEncoder</a></code>, <code><a href="encoders/primitives/BooleanTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">BooleanTypeEncoder</a></code>, <code><a href="encoders/primitives/ByteTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">ByteTypeEncoder</a></code>, <code><a href="encoders/primitives/CharacterTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">CharacterTypeEncoder</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/primitives/Decimal128TypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">Decimal128TypeEncoder</a></code>, <code><a href="encoders/primitives/Decimal32TypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">Decimal32TypeEncoder</a></code>, <code><a href="encoders/primitives/Decimal64TypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">Decimal64TypeEncoder</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/DeliveryTagEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">DeliveryTagEncoder</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/primitives/DoubleTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">DoubleTypeEncoder</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/primitives/FloatTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">FloatTypeEncoder</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/primitives/IntegerTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">IntegerTypeEncoder</a></code>, <code><a href="encoders/primitives/ListTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">ListTypeEncoder</a></code>, <code><a href="encoders/primitives/LongTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">LongTypeEncoder</a></code>, <code><a href="encoders/primitives/MapTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">MapTypeEncoder</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/primitives/NullTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">NullTypeEncoder</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/primitives/ShortTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">ShortTypeEncoder</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/primitives/StringTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">StringTypeEncoder</a></code>, <code><a href="encoders/primitives/SymbolTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">SymbolTypeEncoder</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/primitives/TimestampTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">TimestampTypeEncoder</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>, <code><a href="encoders/UnknownDescribedTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">UnknownDescribedTypeEncoder</a></code>, <code><a href="encoders/primitives/UnsignedByteTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">UnsignedByteTypeEncoder</a></code>, <code><a href="encoders/primitives/UnsignedIntegerTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">UnsignedIntegerTypeEncoder</a></code>, <code><a href="encoders/primitives/UnsignedLongTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">UnsignedLongTypeEncoder</a></code>, <code><a href="encoders/primitives/UnsignedShortTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">UnsignedShortTypeEncoder</a></code>, <code><a href="encoders/primitives/UUIDTypeEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders.primitives">UUIDTypeEncoder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TypeEncoder&lt;V&gt;</span></div>
<div class="block">Interface for an encoder of a specific AMQP Type.</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="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>&lt;<a href="TypeEncoder.html" title="type parameter in TypeEncoder">V</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isArrayType()" class="member-name-link">isArrayType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)" class="member-name-link">writeArray</a><wbr>(<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" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;values)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Write an array elements of the AMQP type to the given byte buffer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object%5B%5D)" class="member-name-link">writeRawArray</a><wbr>(<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" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;values)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Write an array elements of the AMQP type to the given byte buffer.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,V)" class="member-name-link">writeType</a><wbr>(<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="TypeEncoder.html" title="type parameter in TypeEncoder">V</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Write the full AMQP type data to the given byte buffer.</div>
</div>
</div>
</div>
</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="getTypeClass()">
<h3>getTypeClass</h3>
<div class="member-signature"><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>&lt;<a href="TypeEncoder.html" title="type parameter in TypeEncoder">V</a>&gt;</span>&nbsp;<span class="element-name">getTypeClass</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Class type that this encoder handles.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isArrayType()">
<h3>isArrayType</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isArrayType</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the type handled by this encoded is an AMQP Array type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,V)">
<h3 id="writeType(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object)">writeType</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">writeType</span><wbr><span class="parameters">(<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="TypeEncoder.html" title="type parameter in TypeEncoder">V</a>&nbsp;value)</span>
throws <span class="exceptions"><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></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 class="notes">
<dt>Parameters:</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>
<dt>Throws:</dt>
<dd><code><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while encoding the given value.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object[])">
<h3>writeArray</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">writeArray</span><wbr><span class="parameters">(<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" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;values)</span>
throws <span class="exceptions"><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></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 class="notes">
<dt>Parameters:</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>
<dt>Throws:</dt>
<dd><code><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while encoding the given value.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeRawArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object[])">
<h3>writeRawArray</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">writeRawArray</span><wbr><span class="parameters">(<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" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;values)</span>
throws <span class="exceptions"><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></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 class="notes">
<dt>Parameters:</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>
<dt>Throws:</dt>
<dd><code><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while encoding the given 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>